Sign in
Webhooks

Update a webhook

Updates the configuration of an existing webhook.

put/webhooks/{uid}

Path parameters

uidstring required

Request body

Example request

{
  "webhook": {
    "name": "Updated Webhook",
    "enabled": false
  }
}

Response

webhook updated

uidstring required
namestring nullable required
urlstring nullable required
enabledboolean required
event_typesstring[] required
mode'test' | 'live' nullable required
version1 | 2 | 3 required
api_token_uidsstring[] required
template_uidsstring[] required
folder_uidsstring[] required
include_submission_databoolean required
strip_fieldsstring[] required
headersobject required
consecutive_failuresinteger required
last_failure_atstring nullable required
disabled_atstring nullable required
disabled_reasonstring nullable required
secretstring nullable required
created_atstring nullable required
updated_atstring nullable required

Changes