Sync Subscriptions from ShipStation
POST/api/shipstation/integration-instances/:integration_instance/webhook-subscriptions/sync
Reconciles the local subscription table with the live webhook list on the ShipStation account (GET /webhooks):
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
- Remote webhooks with a recognised event type that are missing locally are added
- Local subscriptions whose ShipStation webhook no longer exists remotely are removed
Returns counts of added/removed plus the resulting total.
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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.