Create a webhook
Webhooks
Create a webhook
Register a new webhook endpoint. The webhook will automatically subscribe to the execution_complete event.
Authentication credentials depend on the auth_type:
no_auth— no additional fields requiredbasic— requiresusernameandpasswordbearer— requirestoken
Requires the write scope.
Create a webhook
Authorizations
Obtain a Bearer token via the Create access token endpoint using the OAuth2 client credentials flow.
Body
application/json
A human-readable name for the webhook.
Example:
"Salesforce Integration"
The HTTPS URL that will receive webhook payloads.
Example:
"https://example.com/webhooks/simpledocs"
The authentication method for webhook delivery.
Available options:
no_auth, basic, bearer Username for basic authentication.
Password for basic authentication.
Bearer token for bearer authentication.
Response
Webhook created successfully.