Skip to main content
You need an HTTPS endpoint you control and a saved credential if the receiver requires authentication.

Configure delivery

Add a Webhook node to your workflow. Set its endpoint URL, HTTP method, credential, headers, and JSON payload template. Enabled webhook nodes run after the conversation completes; they do not need to be on a spoken conversation path. Use POST, PUT, or PATCH to send a JSON body. GET and DELETE requests do not send the payload template as a body.

Payload variables

Example payload template:
Fields can be empty when no value or artifact is available. Check them before updating your application. Only include the fields your receiver needs. initial_context, gathered_context, and annotations can contain caller or conversation data. Recording and transcript links can grant access to call content, so protect the receiver and its logs accordingly. See review with your security team for a broader data-flow walkthrough.

Authenticate requests

Select a stored credential for an API-key header, bearer token, basic authentication, or a custom header. Your receiver must verify that credential before accepting the event. You can add other headers in the Webhook settings.

Build a reliable receiver

Return a successful response promptly and finish slow work in your own application. The request timeout is 30 seconds. Use the run ID to avoid processing the same result twice. Webhook delivery does not provide a configurable automatic retry policy. Inspect delivery results in the run and reconcile missing results with list runs and get a run. Do not rely on a webhook as your only record of an important action.

Test the complete flow

Save your workflow, run a controlled conversation, and confirm that your service receives the expected run ID and fields. Test a rejected credential and a temporarily unavailable receiver so your application can detect missing results.