List Webhook Configurations
GET/api/shipstation/integration-instances/:integration_instance/webhook-subscriptions
Returns the webhook configuration matrix for the instance:
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
configurations— one row per ShipStation event type (SHIP_NOTIFY,ITEM_SHIP_NOTIFY,ORDER_NOTIFY,ITEM_ORDER_NOTIFY,FULFILLMENT_SHIPPED,FULFILLMENT_REJECTED) with label, color, description, and the linked local subscription (subscription_id,shipstation_webhook_id,friendly_name,is_enabled)target_url— the public ingress URL ShipStation should POST notifications to (encodes the integration instance id so tenancy can be initialised)event_type_count— total number of supported event types (6)
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.