Sign in
latestOpenAPI 3.1.02026-08-13233474.8 KB

e920ac8ed225

Webhooks

Update Webhook Registration

Update an existing webhook registration.

put/webhook_registrations/{id}

Path parameters

idstring required

The ID of the webhook registration to update.

The ID of the webhook registration to update.

Request body

targetUrlstring uri

The URL that will receive webhook events.

secretForHMACstring

Secret key used for HMAC signature verification of webhook events.

Response

Returns the updated webhook registration.

idstring required

The ID of the webhook registration.

type'webhook_registration' required

The type of object the attached ID corresponds to.

targetUrlstring uri required

The URL that will receive webhook events.

createdAtstring required

An ISO-8601 string representing the date the webhook registration was created.

secretForHMACboolean required

Whether a secret is currently active for HMAC signature verification of webhook events. We do not ever return the secret so if you have lost your copy, you will need to set a new one.