Webhooks

Define requests that workflows send to another service.

1. Open Account Settings → Gateways → Webhooks and select Add webhook.
2. Enter name and description. Choose Queue based or Realtime and a push method. Queue-based requests can be retried; realtime requests are not queued.
3. Enter the receiver URL and choose TEXT or JSON. For GET, use TEXT and put query parameters in Body. Use receiver parameter names and the displayed contact, staff and remarks variables. JSON variables must be within quoted strings.
4. Choose an authorization method and enter its value, if required. Add custom headers one per line; the page sets Content-Type from Body format.
5. Select Check configuration to validate without contacting the endpoint. Send test webhook sends the current unsaved request immediately using sample data and can trigger the receiver. Inspect the response and receiver logs before retrying after a timeout.
6. Select Save webhook, then select it in the appropriate workflow. A direct test bypasses queueing and retries, so test the workflow separately with an authorized test contact.

For the complete field reference, status actions and test results, see Workflow webhooks. See the webhooks reference for examples.