Sign in
Webhooks

Create a webhook

Creates a webhook that delivers a POST request to your endpoint whenever a subscribed event occurs. Optionally scope the webhook to specific API tokens, templates, or folders.

post/webhooks

Request body

Example request

{
  "webhook": {
    "name": "Test Webhook",
    "url": "https://example.com/webhook",
    "event_types": [
      "submission.processed",
      "submission.failed"
    ],
    "headers": {
      "X-Zapier-Subscription": "123"
    }
  }
}

Response

webhook created

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