Subscribe Webhook
POST/api/shippit/instances/:integration_instance/webhooks/subscribe
Register this instance's inbound webhook URL with Shippit via the merchant API (PUT /merchant), so despatch and delivery events are delivered without pasting the URL into the Shippit dashboard. Runs automatically on connect; this endpoint re-registers it.
Authentication: Requires Bearer token. No request body.
Returns 200 with the subscription timestamp, or 422 {code: invalid_key|api_error} if Shippit rejects the call.
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.