--- title: Event description: >- Retrieve a list of events, which are important actions in the operation of a shop. Shopify records events for a range of resources, and each resource has its own set of actions that create events. api_version: 2026-07 source_url: html: 'https://shopify.dev/docs/api/admin-rest/latest/resources/event' md: 'https://shopify.dev/docs/api/admin-rest/latest/resources/event.md' api_name: admin-rest api_type: rest --- The REST Admin API is a legacy API as of October 1, 2024. Starting April 1, 2025, all new public apps must be built exclusively with the [GraphQL Admin API](https://shopify.dev/docs/api/admin-graphql). For details and migration steps, visit our [migration guide](https://shopify.dev/docs/apps/build/graphql/migrate). # Event Events are generated by some Shopify resources when certain actions are completed, such as the creation of an article, the fulfillment of an order, or the addition of a product. By requesting events, your app can know when certain actions have occurred in the shop. **Note:** The events returned by the Event resource should not be considered to be realtime. Events might not be created until a few seconds after the action occurs. In rare cases it can take up to a few minutes for some events to appear. ![](https://shopify.dev/assets/api/reference/event.png) ## Resources that can create events Events are generated by the following resources: * [Articles](#article-events) * [Blogs](#blog-events) * [Custom collections](#collection-events) * [Comments](#comment-events) * [Orders](#order-events) * [Pages](#page-events) * [Price rules](#price-rule-events) * [Products](#product-events) ### Article events | Verb | Message | Description | | - | - | - | | `create` | New article created: `article_url` | The article was created. | | `destroy` | `article_url` was destroyed. | The article was deleted. | | `published` | `article_url` was published. | The article was published. | | `unpublished` | `article_url` was unpublished. | The article was unpublished. | | `update` | `article_url` was updated (but its published state was not changed). | The article was updated. | ### Blog events | Verb | Message | Description | | - | - | - | | `create` | New blog created: `new_blog_url` | The blog was created. | | `destroy` | `blog_name` was destroyed. | The blog was deleted. | | `update` | `blog_name` was updated. | The blog was updated. | ### Collection events | Verb | Message | Description | | - | - | - | | `create` | New collection created: `collection_url` | The collection was created. | | `destroy` | `collection_url` was destroyed. | The collection was deleted. | | `published` | `collection_url` was published. | The collection was published. | | `unpublished` | `collection_url` was hidden. | The collection was hidden. | | `update` | `collection_url` was updated. | The collection was updated. | ### Comment events | Verb | Message | Description | | - | - | - | | `create` | New comment for `article_url`: `comment_excerpt` | The comment was created. | ### Order events Order events can be divided into the following categories: * **Authorization**: Includes whether the authorization succeeded, failed, or is pending. * **Capture**: Includes whether the capture succeeded, failed, or is pending. * **Email**: Includes confirmation or cancellation of the order, as well as shipping. * **Fulfillment**: Includes whether the fulfillment succeeded, failed, or is pending. Also includes cancellation, restocking, and fulfillment updates. * **Order**: Includess the placement, confirmation, closing, re-opening, and cancellation of the order. * **Refund**: Includes whether the refund succeeded, failed, or is pending. * **Sale**: Includes whether the sale succeeded, failed, or is pending. * **Void**: Includes whether the void succeeded, failed, or is pending. | Verb | Message | Description | | - | - | - | | `authorization_failure` | The customer, unsuccessfully, tried to authorize: `money_amount` | Authorization failed. The funds cannot be captured. | | `authorization_pending` | Authorization for `money_amount` is pending. | Authorization failed. The funds cannot be captured. | | `authorization_success` | The customer successfully authorized us to capture: `money_amount` | Authorization was successful and the funds are available for capture. | | `cancelled` | Order was cancelled by `shop_staff_name`. | The order was cancelled. | | `capture_failure` | We failed to capture: `money_amount` | The capture failed. The funds cannot be transferred to the shop. | | `capture_pending` | Capture for `money_amount` is pending. | The capture is in process. The funds are not yet available to the shop. | | `capture_success` | We successfully captured: `money_amount` | The capture was successful and the funds are now available to the shop. | | `closed` | Order was closed. | The order was closed. | | `confirmed` | Received a new order: `order_number` by `customer_name`. | The order was confirmed. | | `fulfillment_cancelled` | We cancelled `number_of_line_items` from being fulfilled by the third party fulfillment service. | Fulfillment for one or more of the line\_items failed. | | `fulfillment_pending` | We submitted `number_of_line_items` to the third party service. | One or more of the line\_items has been assigned to a third party service for fulfillment. | | `fulfillment_success` | We successfully fulfilled line\_items. | Fulfillment was successful for one or more line\_items. | | `mail_sent` | `message_type` email was sent to the customer. | An email was sent to the customer. | | `placed` | Order was placed. | An order was placed by the customer. | | `re_opened` | Order was re-opened. | The order was re-opened. | | `refund_failure` | We failed to refund `money_amount`. | The refund failed. The funds are still with the shop. | | `refund_pending` | Refund of `money_amount` is still pending. | THe refund is in process. The funds are still with shop. | | `refund_success` | We successfully refunded `money_amount`. | The refund was successful. The funds have been transferred to the customer. | | `restock_line_items` | We restocked `number_of_line_items`. | One or more of the order's line items have been restocked. | | `sale_failure` | The customer failed to pay `money_amount`. | The sale failed. The funds are not available to the shop. | | `sale_pending` | The `money_amount` is pending. | The sale is in process. The funds are not yet available to the shop. | | `sale_success` | We successfully captured `money_amount`. | The sale was successful. The funds are now with the shop. | | `update` | `order_number` was updated. | The order was updated. | | `void_failure` | We failed to void the authorization. | Voiding the authorization failed. The authorization is still valid. | | `void_pending` | Authorization void is pending. | Voiding the authorization is in process. The authorization is still valid. | | `void_success` | We successfully voided the authorization. | Voiding the authorization was successful. The authorization is no longer valid. | ### Page events | Verb | Message | Description | | - | - | - | | `create` | New page created: `page_url` | The page was created. | | `destroy` | `page_url` was destroyed. | The page was deleted. | | `published` | `page_url` was published. | The page was published. | | `unpublished` | `page_url` was hidden. | The page was hidden. | | `update` | `page_url` was updated. | The page was updated. | ### Price rule events | Verb | Message | Description | | - | - | - | | `create` | New price rule created: `price_rule` | The price rule was created. | | `destroy` | `price_rule` was destroyed. | The price rule was deleted. | | `update` | `price_rule` was updated. | The price rule was updated. | ### Product events | Verb | Message | Description | | - | - | - | | `create` | New product created: `product_title` | The product was created. | | `destroy` | `product_name` was destroyed. | The product was deleted. | | `published` | `product_title` was published. | The product was published. | | `unpublished` | `product_title` was hidden. | The product was hidden. | \# ## Endpoints * [get](https://shopify.dev/docs/api/admin-rest/latest/resources/event.md#get-events) [/admin/api/latest/events.​json](https://shopify.dev/docs/api/admin-rest/latest/resources/event.md#get-events) Retrieves a list of events [events](https://shopify.dev/docs/api/admin-graphql/latest/queries/events?example=retrieves-a-list-of-events) * [get](https://shopify.dev/docs/api/admin-rest/latest/resources/event.md#get-events-event-id) [/admin/api/latest/events/{event\_​id}.​json](https://shopify.dev/docs/api/admin-rest/latest/resources/event.md#get-events-event-id) Retrieves a single event [event](https://shopify.dev/docs/api/admin-graphql/latest/queries/event?example=retrieves-a-single-event) * [get](https://shopify.dev/docs/api/admin-rest/latest/resources/event.md#get-events-count) [/admin/api/latest/events/count.​json](https://shopify.dev/docs/api/admin-rest/latest/resources/event.md#get-events-count) Retrieves a count of events [eventsCount](https://shopify.dev/docs/api/admin-graphql/latest/queries/eventsCount?example=retrieves-a-count-of-events) *** ## The Event resource ### Properties *** arguments ->[arguments](https://shopify.dev/docs/api/admin-graphql/latest/objects/BasicEvent#field-BasicEvent.fields.arguments) Refers to a certain event and its resources. *** body ->[additionalContent](https://shopify.dev/docs/api/admin-graphql/latest/objects/BasicEvent#field-BasicEvent.fields.additionalContent) A text field containing information about the event. *** created\_at ->[createdAt](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Event#fields-createdAt) The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the event was created. *** id ->[id](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Event#fields-id) The ID of the event. *** description **deprecated** A human readable description of the event. *** path ->[eventLabel](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Event) A relative URL to the resource the event is for, if applicable. *** message ->[message](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Event#fields-message) A human readable description of the event. Can contain some HTML formatting. *** subject\_id ->[subject](https://shopify.dev/docs/api/admin-graphql/latest/objects/BasicEvent#field-BasicEvent.fields.subject) The ID of the resource that generated the event. *** subject\_type ->[subjectType](https://shopify.dev/docs/api/admin-graphql/latest/objects/BasicEvent#field-BasicEvent.fields.subjectType) The type of the resource that generated the event. Valid values: * `Article` * `Blog` * `Collection` * `Comment` * `Order` * `Page` * `PriceRule` * `Product` * `ApiPermission` *** verb ->[action](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Event#fields-action) The type of event that occurred. Different resources generate different types of event. See the [Resources](#resources-that-can-create-events) section for a list of possible verbs. *** author ->[author](https://shopify.dev/docs/api/admin-graphql/latest/objects/BasicEvent#field-BasicEvent.fields.author) The entity which performed the action that generated the event. *** {} ## The Event resource ```json { "arguments": [ "IPod Nano - 8GB" ], "body": null, "created_at": "2025-11-20T08:33:57-11:00", "id": 164748010, "description": "Received a new order", "path": "/admin/orders/406514653/transactions/#1145", "message": "Received new order", "subject_id": 406514653, "subject_type": "Order", "verb": "confirmed", "author": "JaneDoe23" } ``` *** ## getRetrieves a list of events [events](https://shopify.dev/docs/api/admin-graphql/latest/queries/events?example=retrieves-a-list-of-events) Retrieves a list of events. **Note:** This endpoint implements pagination by using links that are provided in the response header. To learn more, refer to [Make paginated requests to the REST Admin API](https://shopify.dev/api/usage/pagination-rest). ### Parameters *** api\_version **string** **required** *** created\_at\_max Show events created at or before this date and time. Event data is retained for 1 year. (format: 2025-11-25T16:15:47-04:00) *** created\_at\_min Show events created at or after this date and time. Event data is retained for 1 year. (format: 2025-08-25T16:15:47-04:00) *** fields Show only certain fields, specified by a comma-separated list of field names. *** filter Show events of certain resources, specified by a comma-separated list of resource names. *** limit **≤ 250** **default 50** The number of results to show. *** since\_id Show only results after the specified ID. *** verb Show events of a certain type. *** ### Examples ### Retrieve a list of all events for a shop ### Retrieve a list of all events from a specific order ### Retrieve a list of all events related to products and orders ### Query parameters filter=​Product,​Order Show events of certain resources, specified by a comma-separated list of resource names. ### Retrieve a list of events related to products that were deleted ### Query parameters filter=​Product Show events of certain resources, specified by a comma-separated list of resource names. verb=​destroy Show events of a certain type. ### Retrieve a list of events that occured at the specified time ### Query parameters created\_​at\_​min=​2008-01-10+12:30:00+00:00 Show events created at or after this date and time. Event data is retained for 1 year. (format: 2025-08-25T16:15:47-04:00) ### Retrieve all events after the specified ID ### Query parameters since\_​id=​164748010 Show only results after the specified ID. ### Retrieve all events from a specific product ### Retrieve an event after a specific ID using `since_id` ### Query parameters limit=​1 **≤ 250** **default 50** The number of results to show. since\_​id=​164748010 Show only results after the specified ID. get ## /admin/api/2026-07/events.​json ```bash curl -X GET "https://your-development-store.myshopify.com/admin/api/2026-07/events.json" \ -H "X-Shopify-Access-Token: {access_token}" ``` {} ## Response JSON ```json HTTP/1.1 200 OK { "events": [ { "id": 164748010, "subject_id": 450789469, "created_at": "2008-01-10T06:00:00-05:00", "subject_type": "Order", "verb": "confirmed", "arguments": [ "#1001", "Bob Norman" ], "body": null, "message": "Received new order #1001 by Bob Norman.", "author": "Shopify", "description": "Received new order #1001 by Bob Norman.", "path": "/admin/orders/450789469" }, { "id": 365755215, "subject_id": 632910392, "created_at": "2008-01-10T07:00:00-05:00", "subject_type": "Product", "verb": "create", "arguments": [ "IPod Nano - 8GB" ], "body": null, "message": "Product was created: IPod Nano - 8GB.", "author": "Shopify", "description": "Product was created: IPod Nano - 8GB.", "path": "/admin/products/632910392" }, { "id": 677313116, "subject_id": 921728736, "created_at": "2008-01-10T08:00:00-05:00", "subject_type": "Product", "verb": "create", "arguments": [ "IPod Touch 8GB" ], "body": null, "message": "Product was created: IPod Touch 8GB.", "author": "Shopify", "description": "Product was created: IPod Touch 8GB.", "path": "/admin/products/921728736" } ] } ``` ### examples * #### Retrieve a list of all events for a shop ##### ```curl curl -X GET "https://your-development-store.myshopify.com/admin/api/2026-07/events.json" \ -H "X-Shopify-Access-Token: {access_token}" ``` #### response ```json HTTP/1.1 200 OK{"events":[{"id":164748010,"subject_id":450789469,"created_at":"2008-01-10T06:00:00-05:00","subject_type":"Order","verb":"confirmed","arguments":["#1001","Bob Norman"],"body":null,"message":"Received new order #1001 by Bob Norman.","author":"Shopify","description":"Received new order #1001 by Bob Norman.","path":"/admin/orders/450789469"},{"id":365755215,"subject_id":632910392,"created_at":"2008-01-10T07:00:00-05:00","subject_type":"Product","verb":"create","arguments":["IPod Nano - 8GB"],"body":null,"message":"Product was created: IPod Nano - 8GB.","author":"Shopify","description":"Product was created: IPod Nano - 8GB.","path":"/admin/products/632910392"},{"id":677313116,"subject_id":921728736,"created_at":"2008-01-10T08:00:00-05:00","subject_type":"Product","verb":"create","arguments":["IPod Touch 8GB"],"body":null,"message":"Product was created: IPod Touch 8GB.","author":"Shopify","description":"Product was created: IPod Touch 8GB.","path":"/admin/products/921728736"}]} ``` * #### Retrieve a list of all events from a specific order ##### ```curl curl -X GET "https://your-development-store.myshopify.com/admin/api/2026-07/orders/450789469/events.json" \ -H "X-Shopify-Access-Token: {access_token}" ``` * #### Retrieve a list of all events related to products and orders ##### ```curl curl -X GET "https://your-development-store.myshopify.com/admin/api/2026-07/events.json?filter=Product%2COrder" \ -H "X-Shopify-Access-Token: {access_token}" ``` * #### Retrieve a list of events related to products that were deleted ##### ```curl curl -X GET "https://your-development-store.myshopify.com/admin/api/2026-07/events.json?filter=Product&verb=destroy" \ -H "X-Shopify-Access-Token: {access_token}" ``` * #### Retrieve a list of events that occured at the specified time ##### ```curl curl -X GET "https://your-development-store.myshopify.com/admin/api/2026-07/events.json?created_at_min=2008-01-10+12%3A30%3A00%2B00%3A00" \ -H "X-Shopify-Access-Token: {access_token}" ``` * #### Retrieve all events after the specified ID ##### ```curl curl -X GET "https://your-development-store.myshopify.com/admin/api/2026-07/events.json?since_id=164748010" \ -H "X-Shopify-Access-Token: {access_token}" ``` * #### Retrieve all events from a specific product ##### ```curl curl -X GET "https://your-development-store.myshopify.com/admin/api/2026-07/products/921728736/events.json" \ -H "X-Shopify-Access-Token: {access_token}" ``` * #### Retrieve an event after a specific ID using \since\_id\ ##### ```curl curl -X GET "https://your-development-store.myshopify.com/admin/api/2026-07/orders/450789469/events.json?limit=1&since_id=164748010" \ -H "X-Shopify-Access-Token: {access_token}" ``` *** ## getRetrieves a single event [event](https://shopify.dev/docs/api/admin-graphql/latest/queries/event?example=retrieves-a-single-event) Retrieves a single event by its ID ### Parameters *** api\_version **string** **required** *** event\_id **string** **required** *** fields Show only certain fields, specified by a comma-separated list of field names. *** ### Examples ### Retrieves a single event by its ID ### Path parameters event\_​id=​677313116 **string** **required** get ## /admin/api/2026-07/events/677313116.​json ```bash curl -X GET "https://your-development-store.myshopify.com/admin/api/2026-07/events/677313116.json" \ -H "X-Shopify-Access-Token: {access_token}" ``` {} ## Response JSON ```json HTTP/1.1 200 OK { "event": { "id": 677313116, "subject_id": 921728736, "created_at": "2008-01-10T08:00:00-05:00", "subject_type": "Product", "verb": "create", "arguments": [ "IPod Touch 8GB" ], "body": null, "message": "Product was created: IPod Touch 8GB.", "author": "Shopify", "description": "Product was created: IPod Touch 8GB.", "path": "/admin/products/921728736" } } ``` ### examples * #### Retrieves a single event by its ID ##### ```curl curl -X GET "https://your-development-store.myshopify.com/admin/api/2026-07/events/677313116.json" \ -H "X-Shopify-Access-Token: {access_token}" ``` #### response ```json HTTP/1.1 200 OK{"event":{"id":677313116,"subject_id":921728736,"created_at":"2008-01-10T08:00:00-05:00","subject_type":"Product","verb":"create","arguments":["IPod Touch 8GB"],"body":null,"message":"Product was created: IPod Touch 8GB.","author":"Shopify","description":"Product was created: IPod Touch 8GB.","path":"/admin/products/921728736"}} ``` *** ## getRetrieves a count of events [eventsCount](https://shopify.dev/docs/api/admin-graphql/latest/queries/eventsCount?example=retrieves-a-count-of-events) Retrieves a count of events ### Parameters *** api\_version **string** **required** *** created\_at\_max Count only events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00) *** created\_at\_min Count only events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00) *** ### Examples ### Count all events ### Count of the number of events since a particular time ### Query parameters created\_​at\_​min=​2008-01-10T13:00:00+00:00 Count only events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00) get ## /admin/api/2026-07/events/count.​json ```bash curl -X GET "https://your-development-store.myshopify.com/admin/api/2026-07/events/count.json" \ -H "X-Shopify-Access-Token: {access_token}" ``` {} ## Response JSON ```json HTTP/1.1 200 OK { "count": 3 } ``` ### examples * #### Count all events ##### ```curl curl -X GET "https://your-development-store.myshopify.com/admin/api/2026-07/events/count.json" \ -H "X-Shopify-Access-Token: {access_token}" ``` #### response ```json HTTP/1.1 200 OK{"count":3} ``` * #### Count of the number of events since a particular time ##### ```curl curl -X GET "https://your-development-store.myshopify.com/admin/api/2026-07/events/count.json?created_at_min=2008-01-10T13%3A00%3A00%2B00%3A00" \ -H "X-Shopify-Access-Token: {access_token}" ```