Update webhook subscription
Updates an existing webhook subscription.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
subscriptionId
Webhook subscription ID.
Headers
X-Tenant-Id
Tenant context used for authorization and routing.
Idempotency-Key
Optional client-generated idempotency token (recommended for safe retries).
Request
This endpoint expects an object.
url
eventTypes
active
Enable or disable the subscription.
authType
Omit to leave authentication untouched. Send NONE to delete the stored HMAC key and stop signing deliveries. Any value other than HMAC or NONE is rejected.
Allowed values:
secret
New HMAC key. The current key is never returned, so leaving this out keeps it as is — send a value only to rotate the key.
Response
Webhook subscription updated.
subscriptionId
Unique subscription identifier.
tenantId
Tenant that owns this subscription.
url
URL that receives webhook events.
active
Whether the subscription is active.
eventTypes
Event types this subscription receives.
authType
Authentication applied to delivery.
hmacSecretSet
Whether an HMAC key is stored. The key itself is never returned by any endpoint.
createdAt
updatedAt
accountId
Account this subscription is bound to. null means tenant-wide: it receives every account’s events.
Errors
400
Bad Request Error
404
Not Found Error
500
Internal Server Error