Shopify Admin API · AsyncAPI Specification

Shopify Admin Webhooks

Version 2024-10

AsyncAPI 2.6 specification modeling the Shopify Admin webhook event surface. Shopify webhooks allow apps to subscribe to events that occur in a Shopify store. When a subscribed event occurs, Shopify sends an HTTP POST request with a JSON payload to the configured endpoint URL. Every webhook delivery from Shopify includes the following HTTP headers: - `X-Shopify-Topic` — the webhook topic (for example, `orders/create`) - `X-Shopify-Shop-Domain` — the `*.myshopify.com` domain that triggered the event - `X-Shopify-Hmac-Sha256` — base64-encoded HMAC-SHA256 of the raw request body computed using the app's client secret (or, for shop-created webhooks via the REST/GraphQL Admin API, the app's API secret key) as the key - `X-Shopify-API-Version` — the Admin API version used to format the payload - `X-Shopify-Webhook-Id` — a unique identifier for the webhook delivery Receivers MUST verify the HMAC signature before processing a payload. Receivers MUST respond with a `2xx` status code within 5 seconds; Shopify retries failed deliveries up to 19 times over 48 hours. Every topic enumerated in this specification is drawn from the official Shopify Admin webhooks reference at https://shopify.dev/docs/api/webhooks/2024-10.

View Spec View on GitHub CommerceEcommerceAdminProductsOrdersCustomersAsyncAPIWebhooksEvents

Channels

app/scopes_update
subscribe subscribeAppScopesUpdate
Receive app/scopes_update events.
Triggered when the access scopes granted to an app are updated.
app/uninstalled
subscribe subscribeAppUninstalled
Receive app/uninstalled events.
Triggered when an app is uninstalled from a shop. Mandatory compliance topic for App Store apps.
app_purchases_one_time/update
subscribe subscribeAppPurchasesOneTimeUpdate
Receive app_purchases_one_time/update events.
Triggered when a one-time application charge is updated.
app_subscriptions/approaching_capped_amount
subscribe subscribeAppSubscriptionsApproachingCappedAmount
Receive app_subscriptions/approaching_capped_amount events.
Triggered when an app subscription's usage charges approach the capped amount.
app_subscriptions/update
subscribe subscribeAppSubscriptionsUpdate
Receive app_subscriptions/update events.
Triggered when an app subscription is updated.
audit_events/admin_api_activity
subscribe subscribeAuditEventsAdminApiActivity
Receive audit_events/admin_api_activity events.
Triggered when admin API activity is recorded as an audit event.
bulk_operations/finish
subscribe subscribeBulkOperationsFinish
Receive bulk_operations/finish events.
Triggered when a bulk operation finishes.
carts/create
subscribe subscribeCartsCreate
Receive carts/create events.
Triggered when a cart is created in the online store.
carts/update
subscribe subscribeCartsUpdate
Receive carts/update events.
Triggered when a cart is updated in the online store.
channels/delete
subscribe subscribeChannelsDelete
Receive channels/delete events.
Triggered when a sales channel is removed from the shop.
checkouts/create
subscribe subscribeCheckoutsCreate
Receive checkouts/create events.
Triggered when a checkout is created.
checkouts/delete
subscribe subscribeCheckoutsDelete
Receive checkouts/delete events.
Triggered when a checkout is deleted.
checkouts/update
subscribe subscribeCheckoutsUpdate
Receive checkouts/update events.
Triggered when a checkout is updated.
collection_listings/add
subscribe subscribeCollectionListingsAdd
Receive collection_listings/add events.
Triggered when a collection listing is added to a sales channel.
collection_listings/remove
subscribe subscribeCollectionListingsRemove
Receive collection_listings/remove events.
Triggered when a collection listing is removed from a sales channel.
collection_listings/update
subscribe subscribeCollectionListingsUpdate
Receive collection_listings/update events.
Triggered when a collection listing is updated on a sales channel.
collection_publications/create
subscribe subscribeCollectionPublicationsCreate
Receive collection_publications/create events.
Triggered when a collection publication is created.
collection_publications/delete
subscribe subscribeCollectionPublicationsDelete
Receive collection_publications/delete events.
Triggered when a collection publication is deleted.
collection_publications/update
subscribe subscribeCollectionPublicationsUpdate
Receive collection_publications/update events.
Triggered when a collection publication is updated.
collections/create
subscribe subscribeCollectionsCreate
Receive collections/create events.
Triggered when a collection is created.
collections/delete
subscribe subscribeCollectionsDelete
Receive collections/delete events.
Triggered when a collection is deleted.
collections/update
subscribe subscribeCollectionsUpdate
Receive collections/update events.
Triggered when a collection is updated.
companies/create
subscribe subscribeCompaniesCreate
Receive companies/create events.
Triggered when a B2B company is created.
companies/delete
subscribe subscribeCompaniesDelete
Receive companies/delete events.
Triggered when a B2B company is deleted.
companies/update
subscribe subscribeCompaniesUpdate
Receive companies/update events.
Triggered when a B2B company is updated.
company_contact_roles/assign
subscribe subscribeCompanyContactRolesAssign
Receive company_contact_roles/assign events.
Triggered when a role is assigned to a company contact.
company_contact_roles/revoke
subscribe subscribeCompanyContactRolesRevoke
Receive company_contact_roles/revoke events.
Triggered when a role is revoked from a company contact.
company_contacts/create
subscribe subscribeCompanyContactsCreate
Receive company_contacts/create events.
Triggered when a company contact is created.
company_contacts/delete
subscribe subscribeCompanyContactsDelete
Receive company_contacts/delete events.
Triggered when a company contact is deleted.
company_contacts/update
subscribe subscribeCompanyContactsUpdate
Receive company_contacts/update events.
Triggered when a company contact is updated.
company_locations/create
subscribe subscribeCompanyLocationsCreate
Receive company_locations/create events.
Triggered when a company location is created.
company_locations/delete
subscribe subscribeCompanyLocationsDelete
Receive company_locations/delete events.
Triggered when a company location is deleted.
company_locations/update
subscribe subscribeCompanyLocationsUpdate
Receive company_locations/update events.
Triggered when a company location is updated.
customer.joined_segment
subscribe subscribeCustomerJoinedSegment
Receive customer.joined_segment events.
Triggered when a customer joins a customer segment.
customer.left_segment
subscribe subscribeCustomerLeftSegment
Receive customer.left_segment events.
Triggered when a customer leaves a customer segment.
customer.tags_added
subscribe subscribeCustomerTagsAdded
Receive customer.tags_added events.
Triggered when tags are added to a customer.
customer.tags_removed
subscribe subscribeCustomerTagsRemoved
Receive customer.tags_removed events.
Triggered when tags are removed from a customer.
customer_account_settings/update
subscribe subscribeCustomerAccountSettingsUpdate
Receive customer_account_settings/update events.
Triggered when customer account settings (login requirements, storefront visibility, etc.) are updated.
customer_groups/create
subscribe subscribeCustomerGroupsCreate
Receive customer_groups/create events.
Triggered when a customer saved search (group) is created.
customer_groups/delete
subscribe subscribeCustomerGroupsDelete
Receive customer_groups/delete events.
Triggered when a customer saved search (group) is deleted.
customer_groups/update
subscribe subscribeCustomerGroupsUpdate
Receive customer_groups/update events.
Triggered when a customer saved search (group) is updated.
customer_payment_methods/create
subscribe subscribeCustomerPaymentMethodsCreate
Receive customer_payment_methods/create events.
Triggered when a customer payment method is created.
customer_payment_methods/revoke
subscribe subscribeCustomerPaymentMethodsRevoke
Receive customer_payment_methods/revoke events.
Triggered when a customer payment method is revoked.
customer_payment_methods/update
subscribe subscribeCustomerPaymentMethodsUpdate
Receive customer_payment_methods/update events.
Triggered when a customer payment method is updated.
customers/create
subscribe subscribeCustomersCreate
Receive customers/create events.
Triggered when a customer is created.
customers/data_request
subscribe subscribeCustomersDataRequest
Receive customers/data_request events.
Triggered when a store owner requests a customer's data on their behalf. Mandatory compliance topic for App Store apps.
customers/delete
subscribe subscribeCustomersDelete
Receive customers/delete events.
Triggered when a customer is deleted.
customers/disable
subscribe subscribeCustomersDisable
Receive customers/disable events.
Triggered when a customer account is disabled.
customers/enable
subscribe subscribeCustomersEnable
Receive customers/enable events.
Triggered when a customer account is enabled.
customers/merge
subscribe subscribeCustomersMerge
Receive customers/merge events.
Triggered when two customer records are merged.
customers/purchasing_summary
subscribe subscribeCustomersPurchasingSummary
Receive customers/purchasing_summary events.
Triggered when a customer's purchasing summary changes.
customers/redact
subscribe subscribeCustomersRedact
Receive customers/redact events.
Triggered 48 hours after a store owner requests that a customer's personal data be redacted. Mandatory compliance topic for App Store apps.
customers/update
subscribe subscribeCustomersUpdate
Receive customers/update events.
Triggered when a customer is updated.
customers_email_marketing_consent/update
subscribe subscribeCustomersEmailMarketingConsentUpdate
Receive customers_email_marketing_consent/update events.
Triggered when a customer's email marketing consent is updated.
customers_marketing_consent/update
subscribe subscribeCustomersMarketingConsentUpdate
Receive customers_marketing_consent/update events.
Triggered when a customer's SMS marketing consent is updated.
delivery_promise_settings/update
subscribe subscribeDeliveryPromiseSettingsUpdate
Receive delivery_promise_settings/update events.
Triggered when delivery promise settings (processing time, delivery date availability) are updated.
discounts/create
subscribe subscribeDiscountsCreate
Receive discounts/create events.
Triggered when a discount is created.
discounts/delete
subscribe subscribeDiscountsDelete
Receive discounts/delete events.
Triggered when a discount is deleted.
discounts/redeemcode_added
subscribe subscribeDiscountsRedeemcodeAdded
Receive discounts/redeemcode_added events.
Triggered when a redeem code is added to a discount.
discounts/redeemcode_removed
subscribe subscribeDiscountsRedeemcodeRemoved
Receive discounts/redeemcode_removed events.
Triggered when a redeem code is removed from a discount.
discounts/update
subscribe subscribeDiscountsUpdate
Receive discounts/update events.
Triggered when a discount is updated.
disputes/create
subscribe subscribeDisputesCreate
Receive disputes/create events.
Triggered when a payment dispute (chargeback or inquiry) is created.
disputes/update
subscribe subscribeDisputesUpdate
Receive disputes/update events.
Triggered when a payment dispute is updated.
domains/create
subscribe subscribeDomainsCreate
Receive domains/create events.
Triggered when a shop adds a domain.
domains/destroy
subscribe subscribeDomainsDestroy
Receive domains/destroy events.
Triggered when a shop removes a domain.
domains/update
subscribe subscribeDomainsUpdate
Receive domains/update events.
Triggered when a shop updates a domain.
draft_orders/create
subscribe subscribeDraftOrdersCreate
Receive draft_orders/create events.
Triggered when a draft order is created.
draft_orders/delete
subscribe subscribeDraftOrdersDelete
Receive draft_orders/delete events.
Triggered when a draft order is deleted.
draft_orders/update
subscribe subscribeDraftOrdersUpdate
Receive draft_orders/update events.
Triggered when a draft order is updated.
fulfillment_events/create
subscribe subscribeFulfillmentEventsCreate
Receive fulfillment_events/create events.
Triggered when a fulfillment event is created.
fulfillment_events/delete
subscribe subscribeFulfillmentEventsDelete
Receive fulfillment_events/delete events.
Triggered when a fulfillment event is deleted.
fulfillment_holds/added
subscribe subscribeFulfillmentHoldsAdded
Receive fulfillment_holds/added events.
Triggered when a hold is added to a fulfillment order.
fulfillment_holds/released
subscribe subscribeFulfillmentHoldsReleased
Receive fulfillment_holds/released events.
Triggered when a hold is released from a fulfillment order.
fulfillment_orders/cancellation_request_accepted
subscribe subscribeFulfillmentOrdersCancellationRequestAccepted
Receive fulfillment_orders/cancellation_request_accepted events.
Triggered when a fulfillment service accepts a cancellation request.
fulfillment_orders/cancellation_request_rejected
subscribe subscribeFulfillmentOrdersCancellationRequestRejected
Receive fulfillment_orders/cancellation_request_rejected events.
Triggered when a fulfillment service rejects a cancellation request.
fulfillment_orders/cancellation_request_submitted
subscribe subscribeFulfillmentOrdersCancellationRequestSubmitted
Receive fulfillment_orders/cancellation_request_submitted events.
Triggered when a cancellation request is submitted for a fulfillment order.
fulfillment_orders/cancelled
subscribe subscribeFulfillmentOrdersCancelled
Receive fulfillment_orders/cancelled events.
Triggered when a fulfillment order is cancelled.
fulfillment_orders/fulfillment_request_accepted
subscribe subscribeFulfillmentOrdersFulfillmentRequestAccepted
Receive fulfillment_orders/fulfillment_request_accepted events.
Triggered when a fulfillment service accepts a fulfillment request.
fulfillment_orders/fulfillment_request_rejected
subscribe subscribeFulfillmentOrdersFulfillmentRequestRejected
Receive fulfillment_orders/fulfillment_request_rejected events.
Triggered when a fulfillment service rejects a fulfillment request.
fulfillment_orders/fulfillment_request_submitted
subscribe subscribeFulfillmentOrdersFulfillmentRequestSubmitted
Receive fulfillment_orders/fulfillment_request_submitted events.
Triggered when a fulfillment request is submitted for a fulfillment order.
fulfillment_orders/fulfillment_service_failed_to_complete
subscribe subscribeFulfillmentOrdersFulfillmentServiceFailedToComplete
Receive fulfillment_orders/fulfillment_service_failed_to_complete events.
Triggered when a fulfillment service fails to complete a fulfillment order.
fulfillment_orders/hold_released
subscribe subscribeFulfillmentOrdersHoldReleased
Receive fulfillment_orders/hold_released events.
Triggered when a hold is released on a fulfillment order.
fulfillment_orders/line_items_prepared_for_local_delivery
subscribe subscribeFulfillmentOrdersLineItemsPreparedForLocalDelivery
Receive fulfillment_orders/line_items_prepared_for_local_delivery events.
Triggered when line items on a fulfillment order are prepared for local delivery.
fulfillment_orders/line_items_prepared_for_pickup
subscribe subscribeFulfillmentOrdersLineItemsPreparedForPickup
Receive fulfillment_orders/line_items_prepared_for_pickup events.
Triggered when line items on a fulfillment order are prepared for in-store pickup.
fulfillment_orders/manually_reported_progress_stopped
subscribe subscribeFulfillmentOrdersManuallyReportedProgressStopped
Receive fulfillment_orders/manually_reported_progress_stopped events.
Triggered when manual progress reporting is stopped on a fulfillment order.
fulfillment_orders/merged
subscribe subscribeFulfillmentOrdersMerged
Receive fulfillment_orders/merged events.
Triggered when fulfillment orders are merged.
fulfillment_orders/moved
subscribe subscribeFulfillmentOrdersMoved
Receive fulfillment_orders/moved events.
Triggered when a fulfillment order is moved to a different location.
fulfillment_orders/order_routing_complete
subscribe subscribeFulfillmentOrdersOrderRoutingComplete
Receive fulfillment_orders/order_routing_complete events.
Triggered when order routing has completed for a fulfillment order.
fulfillment_orders/placed_on_hold
subscribe subscribeFulfillmentOrdersPlacedOnHold
Receive fulfillment_orders/placed_on_hold events.
Triggered when a fulfillment order is placed on hold.
fulfillment_orders/progress_reported
subscribe subscribeFulfillmentOrdersProgressReported
Receive fulfillment_orders/progress_reported events.
Triggered when progress is reported on a fulfillment order.
fulfillment_orders/rescheduled
subscribe subscribeFulfillmentOrdersRescheduled
Receive fulfillment_orders/rescheduled events.
Triggered when a fulfillment order is rescheduled.
fulfillment_orders/scheduled_fulfillment_order_ready
subscribe subscribeFulfillmentOrdersScheduledFulfillmentOrderReady
Receive fulfillment_orders/scheduled_fulfillment_order_ready events.
Triggered when a scheduled fulfillment order is ready to be fulfilled.
fulfillment_orders/split
subscribe subscribeFulfillmentOrdersSplit
Receive fulfillment_orders/split events.
Triggered when a fulfillment order is split.
fulfillments/create
subscribe subscribeFulfillmentsCreate
Receive fulfillments/create events.
Triggered when a fulfillment is created.
fulfillments/update
subscribe subscribeFulfillmentsUpdate
Receive fulfillments/update events.
Triggered when a fulfillment is updated.
inventory_items/create
subscribe subscribeInventoryItemsCreate
Receive inventory_items/create events.
Triggered when an inventory item is created.
inventory_items/delete
subscribe subscribeInventoryItemsDelete
Receive inventory_items/delete events.
Triggered when an inventory item is deleted.
inventory_items/update
subscribe subscribeInventoryItemsUpdate
Receive inventory_items/update events.
Triggered when an inventory item is updated.
inventory_levels/connect
subscribe subscribeInventoryLevelsConnect
Receive inventory_levels/connect events.
Triggered when an inventory level is connected to a location.
inventory_levels/disconnect
subscribe subscribeInventoryLevelsDisconnect
Receive inventory_levels/disconnect events.
Triggered when an inventory level is disconnected from a location.
inventory_levels/update
subscribe subscribeInventoryLevelsUpdate
Receive inventory_levels/update events.
Triggered when an inventory level is updated.
locales/create
subscribe subscribeLocalesCreate
Receive locales/create events.
Triggered when a shop locale is created.
locales/delete
subscribe subscribeLocalesDelete
Receive locales/delete events.
Triggered when a shop locale is deleted.
locales/update
subscribe subscribeLocalesUpdate
Receive locales/update events.
Triggered when a shop locale is updated.
locations/activate
subscribe subscribeLocationsActivate
Receive locations/activate events.
Triggered when a location is reactivated.
locations/create
subscribe subscribeLocationsCreate
Receive locations/create events.
Triggered when a location is created.
locations/deactivate
subscribe subscribeLocationsDeactivate
Receive locations/deactivate events.
Triggered when a location is deactivated.
locations/delete
subscribe subscribeLocationsDelete
Receive locations/delete events.
Triggered when a location is deleted.
locations/update
subscribe subscribeLocationsUpdate
Receive locations/update events.
Triggered when a location is updated.
markets/create
subscribe subscribeMarketsCreate
Receive markets/create events.
Triggered when a market is created.
markets/delete
subscribe subscribeMarketsDelete
Receive markets/delete events.
Triggered when a market is deleted.
markets/update
subscribe subscribeMarketsUpdate
Receive markets/update events.
Triggered when a market is updated.
metaobjects/create
subscribe subscribeMetaobjectsCreate
Receive metaobjects/create events.
Triggered when a metaobject is created.
metaobjects/delete
subscribe subscribeMetaobjectsDelete
Receive metaobjects/delete events.
Triggered when a metaobject is deleted.
metaobjects/update
subscribe subscribeMetaobjectsUpdate
Receive metaobjects/update events.
Triggered when a metaobject is updated.
order_transactions/create
subscribe subscribeOrderTransactionsCreate
Receive order_transactions/create events.
Triggered when an order transaction is created.
orders/cancelled
subscribe subscribeOrdersCancelled
Receive orders/cancelled events.
Triggered when an order is cancelled.
orders/create
subscribe subscribeOrdersCreate
Receive orders/create events.
Triggered when an order is created.
orders/delete
subscribe subscribeOrdersDelete
Receive orders/delete events.
Triggered when an order is deleted.
orders/edited
subscribe subscribeOrdersEdited
Receive orders/edited events.
Triggered when an order is edited.
orders/fulfilled
subscribe subscribeOrdersFulfilled
Receive orders/fulfilled events.
Triggered when an order is fulfilled.
orders/fully_paid
subscribe subscribeOrdersFullyPaid
Receive orders/fully_paid events.
Triggered when an order is fully paid.
orders/paid
subscribe subscribeOrdersPaid
Receive orders/paid events.
Triggered when an order is paid.
orders/partially_fulfilled
subscribe subscribeOrdersPartiallyFulfilled
Receive orders/partially_fulfilled events.
Triggered when an order is partially fulfilled.
orders/partially_refunded
subscribe subscribeOrdersPartiallyRefunded
Receive orders/partially_refunded events.
Triggered when an order is partially refunded.
orders/refunded
subscribe subscribeOrdersRefunded
Receive orders/refunded events.
Triggered when an order is refunded.
orders/risk_assessment_changed
subscribe subscribeOrdersRiskAssessmentChanged
Receive orders/risk_assessment_changed events.
Triggered when the risk assessment of an order changes.
orders/updated
subscribe subscribeOrdersUpdated
Receive orders/updated events.
Triggered when an order is updated.
payment_schedules/due_soon
subscribe subscribePaymentSchedulesDueSoon
Receive payment_schedules/due_soon events.
Triggered when a payment schedule is due soon.
payment_schedules/overdue
subscribe subscribePaymentSchedulesOverdue
Receive payment_schedules/overdue events.
Triggered when a payment schedule is overdue.
payment_schedules/paid
subscribe subscribePaymentSchedulesPaid
Receive payment_schedules/paid events.
Triggered when a payment schedule is paid.
payment_schedules/updated
subscribe subscribePaymentSchedulesUpdated
Receive payment_schedules/updated events.
Triggered when a payment schedule is updated.
payment_terms/create
subscribe subscribePaymentTermsCreate
Receive payment_terms/create events.
Triggered when a payment terms template is created.
payment_terms/delete
subscribe subscribePaymentTermsDelete
Receive payment_terms/delete events.
Triggered when a payment terms template is deleted.
payment_terms/update
subscribe subscribePaymentTermsUpdate
Receive payment_terms/update events.
Triggered when a payment terms template is updated.
product_feeds/create
subscribe subscribeProductFeedsCreate
Receive product_feeds/create events.
Triggered when a product feed is created.
product_feeds/delete
subscribe subscribeProductFeedsDelete
Receive product_feeds/delete events.
Triggered when a product feed is deleted.
product_feeds/full_sync
subscribe subscribeProductFeedsFullSync
Receive product_feeds/full_sync events.
Triggered when a full sync of a product feed occurs.
product_feeds/incremental_sync
subscribe subscribeProductFeedsIncrementalSync
Receive product_feeds/incremental_sync events.
Triggered when an incremental sync of a product feed occurs.
product_feeds/update
subscribe subscribeProductFeedsUpdate
Receive product_feeds/update events.
Triggered when a product feed is updated.
product_listings/add
subscribe subscribeProductListingsAdd
Receive product_listings/add events.
Triggered when a product listing is added to a sales channel.
product_listings/remove
subscribe subscribeProductListingsRemove
Receive product_listings/remove events.
Triggered when a product listing is removed from a sales channel.
product_listings/update
subscribe subscribeProductListingsUpdate
Receive product_listings/update events.
Triggered when a product listing is updated on a sales channel.
product_publications/create
subscribe subscribeProductPublicationsCreate
Receive product_publications/create events.
Triggered when a product publication is created.
product_publications/delete
subscribe subscribeProductPublicationsDelete
Receive product_publications/delete events.
Triggered when a product publication is deleted.
product_publications/update
subscribe subscribeProductPublicationsUpdate
Receive product_publications/update events.
Triggered when a product publication is updated.
products/create
subscribe subscribeProductsCreate
Receive products/create events.
Triggered when a product is created.
products/delete
subscribe subscribeProductsDelete
Receive products/delete events.
Triggered when a product is deleted.
products/update
subscribe subscribeProductsUpdate
Receive products/update events.
Triggered when a product is updated.
profiles/create
subscribe subscribeProfilesCreate
Receive profiles/create events.
Triggered when a delivery profile is created.
profiles/delete
subscribe subscribeProfilesDelete
Receive profiles/delete events.
Triggered when a delivery profile is deleted.
profiles/update
subscribe subscribeProfilesUpdate
Receive profiles/update events.
Triggered when a delivery profile is updated.
publications/create
subscribe subscribePublicationsCreate
Receive publications/create events.
Triggered when a publication is created.
publications/delete
subscribe subscribePublicationsDelete
Receive publications/delete events.
Triggered when a publication is deleted.
publications/update
subscribe subscribePublicationsUpdate
Receive publications/update events.
Triggered when a publication is updated.
refunds/create
subscribe subscribeRefundsCreate
Receive refunds/create events.
Triggered when a refund is created.
returns/cancel
subscribe subscribeReturnsCancel
Receive returns/cancel events.
Triggered when a return is cancelled.
returns/close
subscribe subscribeReturnsClose
Receive returns/close events.
Triggered when a return is closed.
returns/create
subscribe subscribeReturnsCreate
Receive returns/create events.
Triggered when a return is created.
returns/update
subscribe subscribeReturnsUpdate
Receive returns/update events.
Triggered when a return is updated.
reverse_deliveries/complete
subscribe subscribeReverseDeliveriesComplete
Receive reverse_deliveries/complete events.
Triggered when a reverse delivery is completed.
reverse_deliveries/create
subscribe subscribeReverseDeliveriesCreate
Receive reverse_deliveries/create events.
Triggered when a reverse delivery is created.
reverse_deliveries/reopen
subscribe subscribeReverseDeliveriesReopen
Receive reverse_deliveries/reopen events.
Triggered when a reverse delivery is reopened.
reverse_deliveries/update
subscribe subscribeReverseDeliveriesUpdate
Receive reverse_deliveries/update events.
Triggered when a reverse delivery is updated.
reverse_fulfillment_orders/dispose
subscribe subscribeReverseFulfillmentOrdersDispose
Receive reverse_fulfillment_orders/dispose events.
Triggered when a reverse fulfillment order is disposed.
reverse_fulfillment_orders/request
subscribe subscribeReverseFulfillmentOrdersRequest
Receive reverse_fulfillment_orders/request events.
Triggered when a reverse fulfillment order is requested.
scheduled_product_listings/create
subscribe subscribeScheduledProductListingsCreate
Receive scheduled_product_listings/create events.
Triggered when a scheduled product listing is created.
scheduled_product_listings/delete
subscribe subscribeScheduledProductListingsDelete
Receive scheduled_product_listings/delete events.
Triggered when a scheduled product listing is deleted.
scheduled_product_listings/update
subscribe subscribeScheduledProductListingsUpdate
Receive scheduled_product_listings/update events.
Triggered when a scheduled product listing is updated.
segments/create
subscribe subscribeSegmentsCreate
Receive segments/create events.
Triggered when a customer segment is created.
segments/delete
subscribe subscribeSegmentsDelete
Receive segments/delete events.
Triggered when a customer segment is deleted.
segments/update
subscribe subscribeSegmentsUpdate
Receive segments/update events.
Triggered when a customer segment is updated.
selling_plan_groups/create
subscribe subscribeSellingPlanGroupsCreate
Receive selling_plan_groups/create events.
Triggered when a selling plan group is created.
selling_plan_groups/delete
subscribe subscribeSellingPlanGroupsDelete
Receive selling_plan_groups/delete events.
Triggered when a selling plan group is deleted.
selling_plan_groups/update
subscribe subscribeSellingPlanGroupsUpdate
Receive selling_plan_groups/update events.
Triggered when a selling plan group is updated.
shipping_addresses/create
subscribe subscribeShippingAddressesCreate
Receive shipping_addresses/create events.
Triggered when a shipping address is created.
shipping_addresses/delete
subscribe subscribeShippingAddressesDelete
Receive shipping_addresses/delete events.
Triggered when a shipping address is deleted.
shipping_addresses/update
subscribe subscribeShippingAddressesUpdate
Receive shipping_addresses/update events.
Triggered when a shipping address is updated.
shop/redact
subscribe subscribeShopRedact
Receive shop/redact events.
Triggered 48 hours after a shop owner uninstalls an app, requesting that shop data be redacted. Mandatory compliance topic for App Store apps.
shop/update
subscribe subscribeShopUpdate
Receive shop/update events.
Triggered when a shop's configuration is updated.
subscription_billing_attempts/challenged
subscribe subscribeSubscriptionBillingAttemptsChallenged
Receive subscription_billing_attempts/challenged events.
Triggered when a subscription billing attempt is challenged.
subscription_billing_attempts/failure
subscribe subscribeSubscriptionBillingAttemptsFailure
Receive subscription_billing_attempts/failure events.
Triggered when a subscription billing attempt fails.
subscription_billing_attempts/success
subscribe subscribeSubscriptionBillingAttemptsSuccess
Receive subscription_billing_attempts/success events.
Triggered when a subscription billing attempt succeeds.
subscription_billing_cycle_edits/create
subscribe subscribeSubscriptionBillingCycleEditsCreate
Receive subscription_billing_cycle_edits/create events.
Triggered when a subscription billing cycle edit is created.
subscription_billing_cycle_edits/delete
subscribe subscribeSubscriptionBillingCycleEditsDelete
Receive subscription_billing_cycle_edits/delete events.
Triggered when a subscription billing cycle edit is deleted.
subscription_contracts/create
subscribe subscribeSubscriptionContractsCreate
Receive subscription_contracts/create events.
Triggered when a subscription contract is created.
subscription_contracts/delete
subscribe subscribeSubscriptionContractsDelete
Receive subscription_contracts/delete events.
Triggered when a subscription contract is deleted.
subscription_contracts/expire
subscribe subscribeSubscriptionContractsExpire
Receive subscription_contracts/expire events.
Triggered when a subscription contract expires.
subscription_contracts/update
subscribe subscribeSubscriptionContractsUpdate
Receive subscription_contracts/update events.
Triggered when a subscription contract is updated.
tax_partners/create
subscribe subscribeTaxPartnersCreate
Receive tax_partners/create events.
Triggered when a tax partner is created.
tax_partners/delete
subscribe subscribeTaxPartnersDelete
Receive tax_partners/delete events.
Triggered when a tax partner is deleted.
tax_partners/update
subscribe subscribeTaxPartnersUpdate
Receive tax_partners/update events.
Triggered when a tax partner is updated.
tax_services/create
subscribe subscribeTaxServicesCreate
Receive tax_services/create events.
Triggered when a tax service is created.
tax_services/delete
subscribe subscribeTaxServicesDelete
Receive tax_services/delete events.
Triggered when a tax service is deleted.
tax_services/update
subscribe subscribeTaxServicesUpdate
Receive tax_services/update events.
Triggered when a tax service is updated.
tender_transactions/create
subscribe subscribeTenderTransactionsCreate
Receive tender_transactions/create events.
Triggered when a tender transaction is created.
themes/create
subscribe subscribeThemesCreate
Receive themes/create events.
Triggered when a theme is created.
themes/delete
subscribe subscribeThemesDelete
Receive themes/delete events.
Triggered when a theme is deleted.
themes/publish
subscribe subscribeThemesPublish
Receive themes/publish events.
Triggered when a theme is published.
themes/update
subscribe subscribeThemesUpdate
Receive themes/update events.
Triggered when a theme is updated.
variants/create
subscribe subscribeVariantsCreate
Receive variants/create events.
Triggered when a product variant is created.
variants/delete
subscribe subscribeVariantsDelete
Receive variants/delete events.
Triggered when a product variant is deleted.
variants/update
subscribe subscribeVariantsUpdate
Receive variants/update events.
Triggered when a product variant is updated.

Messages

✉
ShopifyWebhook
Shopify Webhook Delivery
A signed Shopify webhook HTTP POST delivery.

Servers

https
webhook-receiver {endpoint}
The application-hosted HTTPS endpoint to which Shopify delivers webhook events. This URL is registered via the `webhookSubscriptionCreate` GraphQL mutation, the REST `POST /admin/api/2024-10/webhooks.json` endpoint, or declaratively in `shopify.app.toml`.

AsyncAPI Specification

Raw ↑ 
asyncapi: 2.6.0
info:
  title: Shopify Admin Webhooks
  version: '2024-10'
  description: |
    AsyncAPI 2.6 specification modeling the Shopify Admin webhook event surface.

    Shopify webhooks allow apps to subscribe to events that occur in a Shopify
    store. When a subscribed event occurs, Shopify sends an HTTP POST request
    with a JSON payload to the configured endpoint URL.

    Every webhook delivery from Shopify includes the following HTTP headers:

    - `X-Shopify-Topic` — the webhook topic (for example, `orders/create`)
    - `X-Shopify-Shop-Domain` — the `*.myshopify.com` domain that triggered the event
    - `X-Shopify-Hmac-Sha256` — base64-encoded HMAC-SHA256 of the raw request
      body computed using the app's client secret (or, for shop-created webhooks
      via the REST/GraphQL Admin API, the app's API secret key) as the key
    - `X-Shopify-API-Version` — the Admin API version used to format the payload
    - `X-Shopify-Webhook-Id` — a unique identifier for the webhook delivery

    Receivers MUST verify the HMAC signature before processing a payload.
    Receivers MUST respond with a `2xx` status code within 5 seconds; Shopify
    retries failed deliveries up to 19 times over 48 hours.

    Every topic enumerated in this specification is drawn from the official
    Shopify Admin webhooks reference at
    https://shopify.dev/docs/api/webhooks/2024-10.
  termsOfService: https://www.shopify.com/legal/terms
  contact:
    name: Shopify Developer Support
    url: https://shopify.dev/
    email: [email protected]
  license:
    name: Proprietary
    url: https://www.shopify.com/legal/terms
  x-apis-json-aid: shopify-admin:shopify-webhooks
  x-spec-source: https://shopify.dev/docs/api/webhooks/2024-10
defaultContentType: application/json
servers:
  webhook-receiver:
    url: '{endpoint}'
    protocol: https
    description: |
      The application-hosted HTTPS endpoint to which Shopify delivers webhook
      events. This URL is registered via the `webhookSubscriptionCreate`
      GraphQL mutation, the REST `POST /admin/api/2024-10/webhooks.json`
      endpoint, or declaratively in `shopify.app.toml`.
    variables:
      endpoint:
        default: https://example.com/shopify/webhooks
        description: The fully-qualified HTTPS callback URL hosted by the app.
channels:
  app/scopes_update:
    description: Triggered when the access scopes granted to an app are updated.
    subscribe:
      operationId: subscribeAppScopesUpdate
      summary: Receive app/scopes_update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: app/scopes_update
  app/uninstalled:
    description: Triggered when an app is uninstalled from a shop. Mandatory compliance topic for App Store apps.
    subscribe:
      operationId: subscribeAppUninstalled
      summary: Receive app/uninstalled events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: app/uninstalled
  app_purchases_one_time/update:
    description: Triggered when a one-time application charge is updated.
    subscribe:
      operationId: subscribeAppPurchasesOneTimeUpdate
      summary: Receive app_purchases_one_time/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: app_purchases_one_time/update
  app_subscriptions/approaching_capped_amount:
    description: Triggered when an app subscription's usage charges approach the capped amount.
    subscribe:
      operationId: subscribeAppSubscriptionsApproachingCappedAmount
      summary: Receive app_subscriptions/approaching_capped_amount events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: app_subscriptions/approaching_capped_amount
  app_subscriptions/update:
    description: Triggered when an app subscription is updated.
    subscribe:
      operationId: subscribeAppSubscriptionsUpdate
      summary: Receive app_subscriptions/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: app_subscriptions/update
  audit_events/admin_api_activity:
    description: Triggered when admin API activity is recorded as an audit event.
    subscribe:
      operationId: subscribeAuditEventsAdminApiActivity
      summary: Receive audit_events/admin_api_activity events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: audit_events/admin_api_activity
  bulk_operations/finish:
    description: Triggered when a bulk operation finishes.
    subscribe:
      operationId: subscribeBulkOperationsFinish
      summary: Receive bulk_operations/finish events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: bulk_operations/finish
  carts/create:
    description: Triggered when a cart is created in the online store.
    subscribe:
      operationId: subscribeCartsCreate
      summary: Receive carts/create events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: carts/create
  carts/update:
    description: Triggered when a cart is updated in the online store.
    subscribe:
      operationId: subscribeCartsUpdate
      summary: Receive carts/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: carts/update
  channels/delete:
    description: Triggered when a sales channel is removed from the shop.
    subscribe:
      operationId: subscribeChannelsDelete
      summary: Receive channels/delete events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: channels/delete
  checkouts/create:
    description: Triggered when a checkout is created.
    subscribe:
      operationId: subscribeCheckoutsCreate
      summary: Receive checkouts/create events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: checkouts/create
  checkouts/delete:
    description: Triggered when a checkout is deleted.
    subscribe:
      operationId: subscribeCheckoutsDelete
      summary: Receive checkouts/delete events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: checkouts/delete
  checkouts/update:
    description: Triggered when a checkout is updated.
    subscribe:
      operationId: subscribeCheckoutsUpdate
      summary: Receive checkouts/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: checkouts/update
  collection_listings/add:
    description: Triggered when a collection listing is added to a sales channel.
    subscribe:
      operationId: subscribeCollectionListingsAdd
      summary: Receive collection_listings/add events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: collection_listings/add
  collection_listings/remove:
    description: Triggered when a collection listing is removed from a sales channel.
    subscribe:
      operationId: subscribeCollectionListingsRemove
      summary: Receive collection_listings/remove events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: collection_listings/remove
  collection_listings/update:
    description: Triggered when a collection listing is updated on a sales channel.
    subscribe:
      operationId: subscribeCollectionListingsUpdate
      summary: Receive collection_listings/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: collection_listings/update
  collection_publications/create:
    description: Triggered when a collection publication is created.
    subscribe:
      operationId: subscribeCollectionPublicationsCreate
      summary: Receive collection_publications/create events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: collection_publications/create
  collection_publications/delete:
    description: Triggered when a collection publication is deleted.
    subscribe:
      operationId: subscribeCollectionPublicationsDelete
      summary: Receive collection_publications/delete events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: collection_publications/delete
  collection_publications/update:
    description: Triggered when a collection publication is updated.
    subscribe:
      operationId: subscribeCollectionPublicationsUpdate
      summary: Receive collection_publications/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: collection_publications/update
  collections/create:
    description: Triggered when a collection is created.
    subscribe:
      operationId: subscribeCollectionsCreate
      summary: Receive collections/create events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: collections/create
  collections/delete:
    description: Triggered when a collection is deleted.
    subscribe:
      operationId: subscribeCollectionsDelete
      summary: Receive collections/delete events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: collections/delete
  collections/update:
    description: Triggered when a collection is updated.
    subscribe:
      operationId: subscribeCollectionsUpdate
      summary: Receive collections/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: collections/update
  companies/create:
    description: Triggered when a B2B company is created.
    subscribe:
      operationId: subscribeCompaniesCreate
      summary: Receive companies/create events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: companies/create
  companies/delete:
    description: Triggered when a B2B company is deleted.
    subscribe:
      operationId: subscribeCompaniesDelete
      summary: Receive companies/delete events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: companies/delete
  companies/update:
    description: Triggered when a B2B company is updated.
    subscribe:
      operationId: subscribeCompaniesUpdate
      summary: Receive companies/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: companies/update
  company_contact_roles/assign:
    description: Triggered when a role is assigned to a company contact.
    subscribe:
      operationId: subscribeCompanyContactRolesAssign
      summary: Receive company_contact_roles/assign events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: company_contact_roles/assign
  company_contact_roles/revoke:
    description: Triggered when a role is revoked from a company contact.
    subscribe:
      operationId: subscribeCompanyContactRolesRevoke
      summary: Receive company_contact_roles/revoke events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: company_contact_roles/revoke
  company_contacts/create:
    description: Triggered when a company contact is created.
    subscribe:
      operationId: subscribeCompanyContactsCreate
      summary: Receive company_contacts/create events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: company_contacts/create
  company_contacts/delete:
    description: Triggered when a company contact is deleted.
    subscribe:
      operationId: subscribeCompanyContactsDelete
      summary: Receive company_contacts/delete events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: company_contacts/delete
  company_contacts/update:
    description: Triggered when a company contact is updated.
    subscribe:
      operationId: subscribeCompanyContactsUpdate
      summary: Receive company_contacts/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: company_contacts/update
  company_locations/create:
    description: Triggered when a company location is created.
    subscribe:
      operationId: subscribeCompanyLocationsCreate
      summary: Receive company_locations/create events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: company_locations/create
  company_locations/delete:
    description: Triggered when a company location is deleted.
    subscribe:
      operationId: subscribeCompanyLocationsDelete
      summary: Receive company_locations/delete events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: company_locations/delete
  company_locations/update:
    description: Triggered when a company location is updated.
    subscribe:
      operationId: subscribeCompanyLocationsUpdate
      summary: Receive company_locations/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: company_locations/update
  customer.joined_segment:
    description: Triggered when a customer joins a customer segment.
    subscribe:
      operationId: subscribeCustomerJoinedSegment
      summary: Receive customer.joined_segment events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customer.joined_segment
  customer.left_segment:
    description: Triggered when a customer leaves a customer segment.
    subscribe:
      operationId: subscribeCustomerLeftSegment
      summary: Receive customer.left_segment events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customer.left_segment
  customer.tags_added:
    description: Triggered when tags are added to a customer.
    subscribe:
      operationId: subscribeCustomerTagsAdded
      summary: Receive customer.tags_added events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customer.tags_added
  customer.tags_removed:
    description: Triggered when tags are removed from a customer.
    subscribe:
      operationId: subscribeCustomerTagsRemoved
      summary: Receive customer.tags_removed events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customer.tags_removed
  customer_account_settings/update:
    description: Triggered when customer account settings (login requirements, storefront visibility, etc.) are updated.
    subscribe:
      operationId: subscribeCustomerAccountSettingsUpdate
      summary: Receive customer_account_settings/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customer_account_settings/update
  customer_groups/create:
    description: Triggered when a customer saved search (group) is created.
    subscribe:
      operationId: subscribeCustomerGroupsCreate
      summary: Receive customer_groups/create events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customer_groups/create
  customer_groups/delete:
    description: Triggered when a customer saved search (group) is deleted.
    subscribe:
      operationId: subscribeCustomerGroupsDelete
      summary: Receive customer_groups/delete events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customer_groups/delete
  customer_groups/update:
    description: Triggered when a customer saved search (group) is updated.
    subscribe:
      operationId: subscribeCustomerGroupsUpdate
      summary: Receive customer_groups/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customer_groups/update
  customer_payment_methods/create:
    description: Triggered when a customer payment method is created.
    subscribe:
      operationId: subscribeCustomerPaymentMethodsCreate
      summary: Receive customer_payment_methods/create events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customer_payment_methods/create
  customer_payment_methods/revoke:
    description: Triggered when a customer payment method is revoked.
    subscribe:
      operationId: subscribeCustomerPaymentMethodsRevoke
      summary: Receive customer_payment_methods/revoke events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customer_payment_methods/revoke
  customer_payment_methods/update:
    description: Triggered when a customer payment method is updated.
    subscribe:
      operationId: subscribeCustomerPaymentMethodsUpdate
      summary: Receive customer_payment_methods/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customer_payment_methods/update
  customers/create:
    description: Triggered when a customer is created.
    subscribe:
      operationId: subscribeCustomersCreate
      summary: Receive customers/create events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customers/create
  customers/data_request:
    description: Triggered when a store owner requests a customer's data on their behalf. Mandatory compliance topic for App Store apps.
    subscribe:
      operationId: subscribeCustomersDataRequest
      summary: Receive customers/data_request events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customers/data_request
  customers/delete:
    description: Triggered when a customer is deleted.
    subscribe:
      operationId: subscribeCustomersDelete
      summary: Receive customers/delete events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customers/delete
  customers/disable:
    description: Triggered when a customer account is disabled.
    subscribe:
      operationId: subscribeCustomersDisable
      summary: Receive customers/disable events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customers/disable
  customers/enable:
    description: Triggered when a customer account is enabled.
    subscribe:
      operationId: subscribeCustomersEnable
      summary: Receive customers/enable events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customers/enable
  customers/merge:
    description: Triggered when two customer records are merged.
    subscribe:
      operationId: subscribeCustomersMerge
      summary: Receive customers/merge events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customers/merge
  customers/purchasing_summary:
    description: Triggered when a customer's purchasing summary changes.
    subscribe:
      operationId: subscribeCustomersPurchasingSummary
      summary: Receive customers/purchasing_summary events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customers/purchasing_summary
  customers/redact:
    description: Triggered 48 hours after a store owner requests that a customer's personal data be redacted. Mandatory compliance topic for App Store apps.
    subscribe:
      operationId: subscribeCustomersRedact
      summary: Receive customers/redact events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customers/redact
  customers/update:
    description: Triggered when a customer is updated.
    subscribe:
      operationId: subscribeCustomersUpdate
      summary: Receive customers/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customers/update
  customers_email_marketing_consent/update:
    description: Triggered when a customer's email marketing consent is updated.
    subscribe:
      operationId: subscribeCustomersEmailMarketingConsentUpdate
      summary: Receive customers_email_marketing_consent/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customers_email_marketing_consent/update
  customers_marketing_consent/update:
    description: Triggered when a customer's SMS marketing consent is updated.
    subscribe:
      operationId: subscribeCustomersMarketingConsentUpdate
      summary: Receive customers_marketing_consent/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: customers_marketing_consent/update
  delivery_promise_settings/update:
    description: Triggered when delivery promise settings (processing time, delivery date availability) are updated.
    subscribe:
      operationId: subscribeDeliveryPromiseSettingsUpdate
      summary: Receive delivery_promise_settings/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: delivery_promise_settings/update
  discounts/create:
    description: Triggered when a discount is created.
    subscribe:
      operationId: subscribeDiscountsCreate
      summary: Receive discounts/create events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: discounts/create
  discounts/delete:
    description: Triggered when a discount is deleted.
    subscribe:
      operationId: subscribeDiscountsDelete
      summary: Receive discounts/delete events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: discounts/delete
  discounts/redeemcode_added:
    description: Triggered when a redeem code is added to a discount.
    subscribe:
      operationId: subscribeDiscountsRedeemcodeAdded
      summary: Receive discounts/redeemcode_added events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: discounts/redeemcode_added
  discounts/redeemcode_removed:
    description: Triggered when a redeem code is removed from a discount.
    subscribe:
      operationId: subscribeDiscountsRedeemcodeRemoved
      summary: Receive discounts/redeemcode_removed events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: discounts/redeemcode_removed
  discounts/update:
    description: Triggered when a discount is updated.
    subscribe:
      operationId: subscribeDiscountsUpdate
      summary: Receive discounts/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: discounts/update
  disputes/create:
    description: Triggered when a payment dispute (chargeback or inquiry) is created.
    subscribe:
      operationId: subscribeDisputesCreate
      summary: Receive disputes/create events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: disputes/create
  disputes/update:
    description: Triggered when a payment dispute is updated.
    subscribe:
      operationId: subscribeDisputesUpdate
      summary: Receive disputes/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: disputes/update
  domains/create:
    description: Triggered when a shop adds a domain.
    subscribe:
      operationId: subscribeDomainsCreate
      summary: Receive domains/create events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: domains/create
  domains/destroy:
    description: Triggered when a shop removes a domain.
    subscribe:
      operationId: subscribeDomainsDestroy
      summary: Receive domains/destroy events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: domains/destroy
  domains/update:
    description: Triggered when a shop updates a domain.
    subscribe:
      operationId: subscribeDomainsUpdate
      summary: Receive domains/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: domains/update
  draft_orders/create:
    description: Triggered when a draft order is created.
    subscribe:
      operationId: subscribeDraftOrdersCreate
      summary: Receive draft_orders/create events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: draft_orders/create
  draft_orders/delete:
    description: Triggered when a draft order is deleted.
    subscribe:
      operationId: subscribeDraftOrdersDelete
      summary: Receive draft_orders/delete events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: draft_orders/delete
  draft_orders/update:
    description: Triggered when a draft order is updated.
    subscribe:
      operationId: subscribeDraftOrdersUpdate
      summary: Receive draft_orders/update events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: draft_orders/update
  fulfillment_events/create:
    description: Triggered when a fulfillment event is created.
    subscribe:
      operationId: subscribeFulfillmentEventsCreate
      summary: Receive fulfillment_events/create events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: fulfillment_events/create
  fulfillment_events/delete:
    description: Triggered when a fulfillment event is deleted.
    subscribe:
      operationId: subscribeFulfillmentEventsDelete
      summary: Receive fulfillment_events/delete events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: fulfillment_events/delete
  fulfillment_holds/added:
    description: Triggered when a hold is added to a fulfillment order.
    subscribe:
      operationId: subscribeFulfillmentHoldsAdded
      summary: Receive fulfillment_holds/added events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: fulfillment_holds/added
  fulfillment_holds/released:
    description: Triggered when a hold is released from a fulfillment order.
    subscribe:
      operationId: subscribeFulfillmentHoldsReleased
      summary: Receive fulfillment_holds/released events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: fulfillment_holds/released
  fulfillment_orders/cancellation_request_accepted:
    description: Triggered when a fulfillment service accepts a cancellation request.
    subscribe:
      operationId: subscribeFulfillmentOrdersCancellationRequestAccepted
      summary: Receive fulfillment_orders/cancellation_request_accepted events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: fulfillment_orders/cancellation_request_accepted
  fulfillment_orders/cancellation_request_rejected:
    description: Triggered when a fulfillment service rejects a cancellation request.
    subscribe:
      operationId: subscribeFulfillmentOrdersCancellationRequestRejected
      summary: Receive fulfillment_orders/cancellation_request_rejected events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: fulfillment_orders/cancellation_request_rejected
  fulfillment_orders/cancellation_request_submitted:
    description: Triggered when a cancellation request is submitted for a fulfillment order.
    subscribe:
      operationId: subscribeFulfillmentOrdersCancellationRequestSubmitted
      summary: Receive fulfillment_orders/cancellation_request_submitted events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: fulfillment_orders/cancellation_request_submitted
  fulfillment_orders/cancelled:
    description: Triggered when a fulfillment order is cancelled.
    subscribe:
      operationId: subscribeFulfillmentOrdersCancelled
      summary: Receive fulfillment_orders/cancelled events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: fulfillment_orders/cancelled
  fulfillment_orders/fulfillment_request_accepted:
    description: Triggered when a fulfillment service accepts a fulfillment request.
    subscribe:
      operationId: subscribeFulfillmentOrdersFulfillmentRequestAccepted
      summary: Receive fulfillment_orders/fulfillment_request_accepted events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: fulfillment_orders/fulfillment_request_accepted
  fulfillment_orders/fulfillment_request_rejected:
    description: Triggered when a fulfillment service rejects a fulfillment request.
    subscribe:
      operationId: subscribeFulfillmentOrdersFulfillmentRequestRejected
      summary: Receive fulfillment_orders/fulfillment_request_rejected events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: fulfillment_orders/fulfillment_request_rejected
  fulfillment_orders/fulfillment_request_submitted:
    description: Triggered when a fulfillment request is submitted for a fulfillment order.
    subscribe:
      operationId: subscribeFulfillmentOrdersFulfillmentRequestSubmitted
      summary: Receive fulfillment_orders/fulfillment_request_submitted events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: fulfillment_orders/fulfillment_request_submitted
  fulfillment_orders/fulfillment_service_failed_to_complete:
    description: Triggered when a fulfillment service fails to complete a fulfillment order.
    subscribe:
      operationId: subscribeFulfillmentOrdersFulfillmentServiceFailedToComplete
      summary: Receive fulfillment_orders/fulfillment_service_failed_to_complete events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: fulfillment_orders/fulfillment_service_failed_to_complete
  fulfillment_orders/hold_released:
    description: Triggered when a hold is released on a fulfillment order.
    subscribe:
      operationId: subscribeFulfillmentOrdersHoldReleased
      summary: Receive fulfillment_orders/hold_released events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: fulfillment_orders/hold_released
  fulfillment_orders/line_items_prepared_for_local_delivery:
    description: Triggered when line items on a fulfillment order are prepared for local delivery.
    subscribe:
      operationId: subscribeFulfillmentOrdersLineItemsPreparedForLocalDelivery
      summary: Receive fulfillment_orders/line_items_prepared_for_local_delivery events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: fulfillment_orders/line_items_prepared_for_local_delivery
  fulfillment_orders/line_items_prepared_for_pickup:
    description: Triggered when line items on a fulfillment order are prepared for in-store pickup.
    subscribe:
      operationId: subscribeFulfillmentOrdersLineItemsPreparedForPickup
      summary: Receive fulfillment_orders/line_items_prepared_for_pickup events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: fulfillment_orders/line_items_prepared_for_pickup
  fulfillment_orders/manually_reported_progress_stopped:
    description: Triggered when manual progress reporting is stopped on a fulfillment order.
    subscribe:
      operationId: subscribeFulfillmentOrdersManuallyReportedProgressStopped
      summary: Receive fulfillment_orders/manually_reported_progress_stopped events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: fulfillment_orders/manually_reported_progress_stopped
  fulfillment_orders/merged:
    description: Triggered when fulfillment orders are merged.
    subscribe:
      operationId: subscribeFulfillmentOrdersMerged
      summary: Receive fulfillment_orders/merged events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: fulfillment_orders/merged
  fulfillment_orders/moved:
    description: Triggered when a fulfillment order is moved to a different location.
    subscribe:
      operationId: subscribeFulfillmentOrdersMoved
      summary: Receive fulfillment_orders/moved events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: fulfillment_orders/moved
  fulfillment_orders/order_routing_complete:
    description: Triggered when order routing has completed for a fulfillment order.
    subscribe:
      operationId: subscribeFulfillmentOrdersOrderRoutingComplete
      summary: Receive fulfillment_orders/order_routing_complete events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: fulfillment_orders/order_routing_complete
  fulfillment_orders/placed_on_hold:
    description: Triggered when a fulfillment order is placed on hold.
    subscribe:
      operationId: subscribeFulfillmentOrdersPlacedOnHold
      summary: Receive fulfillment_orders/placed_on_hold events.
      message:
        $ref: '#/components/messages/ShopifyWebhook'
        x-topic: fulfillment_orders/placed_on_hold
  fulfillment_orders/progress_reported:
    description: Triggered when progress is reported on a fulfillment order.
    subscribe:
      operationI

# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shopify-admin/refs/heads/main/asyncapi/shopify-admin-webhooks-asyncapi.yml