Callbacks

TeXML Gather

Webhook sent when a Gather command completes (sent to the action URL). This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.

postWebhookTexmlGatherWebhook

Headers

telnyx-timestampinteger required

Unix timestamp for replay attack prevention

Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp

telnyx-signature-ed25519string required

Ed25519 signature of timestamp|payload for verification

Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature

Payload application/x-www-form-urlencoded

AccountSidstring required

The unique identifier of the account (user_id).

CallSidstring required

The unique identifier of the call (call_control_id).

CallSidLegacystring required

Legacy call identifier, same as CallSid.

Confidencenumber

The average confidence score of the speech transcription (conditional, only present when input is speech).

Digitsstring

The DTMF digits collected by the Gather command (conditional, only present when input is dtmf).

Fromstring required

The phone number or SIP address of the caller.

SpeechResultstring

The transcribed text from speech input (conditional, only present when input is speech).

Tostring required

The phone number or SIP address that was called.

Example payload

{
  "AccountSid": "cb6cfbbc-eb00-41af-a3f3-0d7b32009e4b",
  "CallSid": "v2:DPNqxVjTNtQYaKdcKbU0QgRFrQ3YzuAQrVYC4Ggcuq7zTpDkUB7A4w",
  "CallSidLegacy": "v2:DPNqxVjTNtQYaKdcKbU0QgRFrQ3YzuAQrVYC4Ggcuq7zTpDkUB7A4w",
  "Digits": "1",
  "From": "Defaultj35z6@sip.telnyx.com",
  "SpeechResult": "Please connect me to sales",
  "To": "+12132045020"
}

Response

The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.