Managing Subscriptions
Deploy Event subscriptions are managed through the Admin API under the storefront-hosting producer. Each subscription delivers a single event type for a single shop key to a URL you provide.
Subscribing through the SCAYLE Panel is not available yet.
Prerequisite: You need an Admin API token with webhook subscription permissions. See Create an Admin API Token on the Webhooks page.
What a subscription looks like
Each subscription:
- Targets one event type (for example,
deployment-succeeded). To receive multiple event types, create one subscription per type. - Is scoped to one shop key via the
meta.shopKeytarget filter.shopKeyis the only supported filter for Deploy Events. - Points to one delivery URL on your side that receives the event payload.
Creating a subscription
Create a subscription with a POST to the subscription endpoint for the storefront-hosting producer.
| Field | Required | Default | Meaning |
|---|---|---|---|
eventName | Yes | - | The event this subscription delivers. See Event Reference for the full list. |
url | Yes | - | Your endpoint that receives the webhook. |
target.shopKey | Yes | - | The shop key this subscription covers. |
enabled | No | true | Set to true to start receiving events. |
rpm | No | - | Maximum requests per minute SCAYLE sends to your endpoint. |
isInternal | No | false | false for external consumers. |
Your shop key is shown on the Shops Dashboard in the SCAYLE Panel.
Repeat for each event type and shop key combination you want to receive.
Listing subscriptions
List all subscriptions for the storefront-hosting producer:
Updating a subscription
Update an existing subscription by its id (returned when you create or list subscriptions):
PUT replaces the whole subscription resource. Include every field you want to keep; fields omitted from the body revert to their default values.
Deleting a subscription
Remove a subscription by its id:
Reference
The complete Admin API webhook endpoints, request formats, and response schemas are documented in the Manage Producer Webhooks in the Admin API section of the Webhooks page.
