Skip to navigation

List webhook subscriptions

Lists all webhook subscriptions configured for the current tenant.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
X-Request-TimestampstringRequired

Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).

X-Content-SHA256stringRequired

Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns 400 body_hash_mismatch.

X-Request-SignaturestringRequired

Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.

Response

List of webhook subscriptions.
subscriptionIdstring
Unique subscription identifier.
tenantIdstring
Tenant that owns this subscription.
urlstringformat: "uri"
URL that receives webhook events.
activeboolean
Whether the subscription is active.
eventTypeslist of stringsOptional
Event types this subscription receives.
authTypeenumOptional
Authentication applied to delivery.
Allowed values:
hmacSecretSetbooleanOptional
Whether an HMAC key is stored. The key itself is never returned by any endpoint.
createdAtdatetimeOptional
updatedAtdatetimeOptional
accountIdstring or nullOptional

Account this subscription is bound to. null means tenant-wide: it receives every account’s events.

Errors

401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error