Get Webhook Subscription
GET/api/shippo/instances/:integration_instance/webhooks/subscription
Returns the webhook registration status, checked live against Shippo's webhook list. The status lists each event SKU.io subscribes to (transaction_created, transaction_updated, track_updated) with whether it is registered at Shippo, its Shippo webhook id, active and is_test flags; plus webhook_url (this instance's inbound URL), subscribed (all events registered), subscribed_at, last_webhook_received_at, failed_event_count and signature_verification (whether HMAC signatures are verified for this instance). If Shippo cannot be reached, registration falls back to the locally stored ids and error carries the reason.
integrations:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Returns 404 for an unknown instance.
Authentication: Requires a Bearer token.
Requires the integrations.show permission.
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
Response Headers
Not Found
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.