{
"id": "<string>",
"category": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"owner": {
"entity": "<string>",
"id": "<string>"
},
"actor": {
"id": "<string>",
"name": "<string>",
"source": "<string>"
},
"operationId": "<string>",
"subscriptionId": "<string>",
"customerId": "<string>",
"summary": "<string>",
"type": "subscription:paused",
"payloadFormat": "typed",
"data": {
"previousStatus": "<string>"
}
}Events
Event resource
This object represents something that happened in your shop.
The
Event object records a single change or action in your shop. Events belong to one of two streams:
activity: everything that happened to subscribers (subscriptions, customers, orders, billing, workflow runs, logins and mail), whoever did it.actor.typesays who did it.audit: shop-level actions, such as settings changes, exports, API access, bulk-action jobs and workflow edits.
payload depends on the event type. Use List event types to see the available types and their payload schemas.
Search query fields
| Field | Description | Type |
|---|---|---|
| type | The event type. Supports comparisons | string |
| stream | The event stream: activity or audit | string |
| occurredAt | When the event happened. Supports comparisons. Date-only values cover the shop-local day; timestamps require an offset | string |
| category | The event category | string |
| severity | The event severity: info or problem | string |
| subscriptionId | The subscription identifier. Matches events owned by the subscription | string |
| customerId | The customer identifier. Includes events of the customer’s subscriptions, orders, workflow runs, payment methods, refunds and chargebacks | string |
| owner.entity | The case-sensitive owner entity name, for example Subscription, Customer or Shop | string |
| owner.id | The owner identifier | string |
| actor.type | Who caused the event: staff, customer, system, bulk-action, api or unknown | string |
| actor.id | The actor identifier | string |
| operationId | The identifier of the operation that produced the event | string |
Reference
- EventPayload_subscription_paused
- EventPayload_subscription_resumed
- EventPayload_subscription_reactivated
- EventPayload_subscription_cancelled
- EventPayload_subscription_skipped
- EventPayload_subscription_next_billing_date_changed
- EventPayload_subscription_payment_method_changed
- EventPayload_subscription_delivery_address_changed
- EventPayload_customer_updated
- EventPayload_customer_payment_method_created
- EventPayload_customer_payment_method_revoked
- EventPayload_customer_logged_in
- EventPayload_customer_login_failed
- EventPayload_settings_updated
- EventPayload_export_created
- EventPayload_api_access_granted
- EventPayload_staff_data_access_spike
- Event
Minimum string length:
1activity: everything that happened to subscribers (subscriptions, customers, orders, billing, workflow runs, logins, mail), whoever did it; actor.type says who (staff, customer, system, bulk-action, api, unknown; staff is the panel). audit: shop-level actions: settings, exports, API access, bulk-action jobs and workflow edits. Fixed per type.
Available options:
activity, audit Minimum string length:
1Available options:
info, problem Show child attributes
Show child attributes
Show child attributes
Show child attributes
Minimum string length:
1Minimum string length:
1Minimum string length:
1Minimum string length:
1Available options:
subscription:paused Available options:
typed Show child attributes
Show child attributes