Get Webhook Endpoint
GET/api/pinnacle/instances/:instance/webhook
Returns the inbound webhook URL and the full inbound key to give Metropolitan Warehouse & Delivery (MWD) so it can push hourly tracking snapshots to SKU.io. MWD must send the key in the header named by header_name (authorization). This is the only endpoint that returns the full key. Also returns the last delivery time and the received / failed counts for the last 24 hours.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: requires a Bearer token (Personal Access Token).
Requires the integrations.update permission, because the response carries the inbound webhook key; without it the request is refused with 403.
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
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.