API ReferenceWebhooks

Update Webhook

Updates the requested webhook.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
idstringRequiredformat: "id"
ID for the webhook.
actionenumOptional
The action to update the webhook's status.
Allowed values:
event_typesobjectOptional
secretstringOptionalformat: "byte"

If provided, updates the secret that’s used when verifying webhook events, which must be between 8 and 32 bytes (inclusive). Otherwise if empty, then a new secret is generated. If the webhook is active, then its status will transition to the ‘unverified’ state and it won’t receive any object events until successfully verified.

urlstringOptionalformat: "text"
The webhook's updated URL. If the webhook is active, then the webhook's status will transition to the 'unverified' state and it won't receive any object events until successfully verified.

Response

The response to updating the webhook.
webhookobject

Errors