Subscribe to Webhook Event
POST/api/shipstation/integration-instances/:integration_instance/webhook-subscriptions
Creates a webhook subscription on the ShipStation account (POST /webhooks/subscribe via the ShipStation V1 API) pointing at this instance's ingress URL, then records it locally.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Body fields:
event_type(required, string) — one of:SHIP_NOTIFY,ITEM_SHIP_NOTIFY,ORDER_NOTIFY,ITEM_ORDER_NOTIFY,FULFILLMENT_SHIPPED,FULFILLMENT_REJECTEDfriendly_name(optional, string, max 255) — display name for the webhook in ShipStation; defaults to the event type label when omitted
Returns 422 when event_type is missing or not one of the allowed values.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 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.
Unprocessable Entity
Response Headers
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.