Sign inGet an API key

Update webhook

Replaces the webhook's URL, event subscription and key scoping. The signing secret is unchanged.

PUT/webhook/{id}
AuthAPI keyorOAuth tokenHow to send it

Path parameters#

idstringrequired

The webhook to update.

e.g. "whk_01KE7XWWEQ4MCGWKBQKJ1G47RP"

Request body#

enabledbooleanrequired

Whether the webhook is enabled. When disabled, no events will be sent to the webhook.

eventsarray | stringrequired

The events to send to the webhook. When 'all', all events will be sent to the webhook.

"all"
urlstringrequired

The URL to send the webhook to. Must be a valid URL.

apiKeyIdsstring[] | null

API keys this webhook is scoped to. When empty or null, every API key delivers to it.

≤ 1000 items
oauthEnabledboolean

Whether tasks authenticated with OAuth (playground and CLI sessions) deliver to this webhook.

Response#

200Webhook updated

dataobjectrequired
apiKeyIdsstring[] | nullrequired
enabledbooleanrequired
eventsstring[] | nullrequired
idstringrequired
oauthEnabledbooleanrequired
urlstringrequired

Errors#

A failed call names what went wrong in code, with a sentence in message. The codes, which of them are worth retrying, and how to read a validation failure are on Errors.