Event APIs

Fetch event data or register webhooks to keep your app synced with the merchant store.

In this section

• BasicEvent — Basic events chronicle resource activities such as the creation of an article, the fulfillment of an order, or the addition of a product.
• CommentEvent — Comment events are generated by staff members of a shop. They are created when a staff member adds a comment to the timeline of an order, draft order, customer, or transfer.
• CommentEventAttachment — A file attachment associated to a comment event.
• CommentEventEmbed — The main embed of a comment event.
• CommentEventSubject — The subject line of a comment event.
• DeletionEvent — Deletion events chronicle the destruction of resources (e.g. products and collections). Once deleted, the deletion event is the only trace of the original’s existence, as the resource itself has been removed and can no longer be accessed.
• DeletionEventSortKeys — The set of valid sort keys for the DeletionEvent query.
• DeletionEventSubjectType — The supported subject types of deletion events.
• Event — Events chronicle resource activities such as the creation of an article, the fulfillment of an order, or the addition of a product.
• EventBridgeWebhookSubscriptionInput — Specifies the input fields for an EventBridge webhook subscription.
• EventSortKeys — The set of valid sort keys for the Event query.
• HasEvents — Connector to event records on a compatible host.
• ResourceAlert — Presents information or problems to merchants, with 1 or more actions that they can take. They can optionally have a specific icon and be dismissed by merchants.
• ResourceAlertAction — An action associated to a resource alert.
• ShopAlert — Alert message that appears in the Shopify admin.
• ShopAlertAction — An action associated to a shop alert.
• WebhookEventBridgeEndpoint — Amazon EventBridge event source.
• WebhookHttpEndpoint — HTTP endpoint where POST requests will be made to.
• WebhookSubscription — Represents a subscription to a webhook.
• WebhookSubscriptionEndpoint — Endpoint where webhooks will be delivered.
• WebhookSubscriptionFormat — The supported formats for webhook subscriptions.
• WebhookSubscriptionInput — Specifies the input fields for a webhook subscription.
• WebhookSubscriptionSortKeys — The set of valid sort keys for the WebhookSubscription query.
• WebhookSubscriptionTopic — The supported topics for webhook subscriptions.
• eventBridgeWebhookSubscriptionCreate — Creates a new Amazon EventBridge webhook subscription.
• eventBridgeWebhookSubscriptionUpdate — Updates an Amazon EventBridge webhook subscription.
• flowTriggerReceive — Triggers a workflow defined by the merchant in Shopify Flow. To learn more, see Create Shopify Flow triggers.
• webhookSubscriptionCreate — Creates a new webhook subscription.
• webhookSubscriptionDelete — Deletes a webhook subscription.
• webhookSubscriptionUpdate — Updates a webhook subscription.