API ReferenceEvent Subscriptions

Update subscription

Partially updates a subscription. Omitted fields keep their current values. Set status to paused to stop deliveries without deleting the subscription, or send a new signingSecret to rotate the signing key.

Authentication

Authorizationstring

Use the API key format: api-key <token>.

Path parameters

subscriptionIdstringRequired
Subscription identifier returned by Create subscription.

Request

This endpoint expects an object.
endpointUrlstringOptionalformat: "^https://.+$"
New HTTPS delivery URL. Plain http is rejected.
eventTypeslist of enumsOptional
Replaces the full set of subscribed event types when provided.
signingSecretstringOptional
Rotates the shared secret used to sign future webhook deliveries.
filtersobjectOptional
Optional delivery filters for a subscription.
statusenumOptional

Set to paused to stop deliveries or active to resume them.

Response

The updated subscription.
idstring
Subscription identifier.
statusenum

active subscriptions receive deliveries; paused ones do not.

endpointUrlstring
HTTPS URL events are delivered to.
eventTypeslist of enums
Event types this subscription receives.
filtersobject
Delivery filters. Omitted when none are configured.
createdAtdatetime
UTC timestamp when the subscription was created.
updatedAtdatetime
UTC timestamp of the last subscription change.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
405
Method Not Allowed Error
406
Not Acceptable Error
422
Unprocessable Entity Error
500
Internal Server Error