Create a webhook

Creates a new webhook definition and returns the persisted record with its server-assigned id. The webhook fires immediately for matching events once created; set enabled=false in the request body to create it in a disabled state.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

WebhookCreateRequest object

Body of a POST /v6/webhooks request.

client_key_id

Choose between static or dynamic client key id

component_ids
array of strings
component_ids
component_references
array of objects
component_references

Choose between static or dynamic default method


Static default method

Choose between static or dynamic description


Static description

Choose between static or dynamic enabled


Static enabled

required

Choose between static or dynamic name


Static name

request

Choose between static or dynamic request

response_body_handler

Choose between static or dynamic response body handler

if no webhook response status is provided, we will retry non 2xx webhook requests


Static response handler

retry_intervals

Choose between static or dynamic retry intervals

tags
array of strings
tags
string
enum
Allowed:
required

Choose between static or dynamic url


Static url

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json