Skip to main content
WEBHOOK
TexmlHttpRequestWebhook
{
  "AccountSid": "f5586561-8ff0-4291-a51b-c7dfe4139ff9",
  "CallSid": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "CallSidLegacy": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "ConnectionId": "1234567890",
  "From": "+35319605860",
  "To": "+13129457420",
  "CallerId": "John Doe"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
telnyx-timestamp
integer<int64>
required

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

​
telnyx-signature-ed25519
string
required

Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature Ed25519 signature of timestamp|payload for verification

Body

application/x-www-form-urlencoded

Webhook sent to the action URL after an HttpRequest instruction completes (when async="false"). This webhook contains standard call parameters plus any custom fields extracted from the HTTP response via Field mappings defined in the Response/Content section.

​
AccountSid
string
required

The unique identifier of the account (user_id).

Example:

"f5586561-8ff0-4291-a51b-c7dfe4139ff9"

​
CallSid
string
required

The unique identifier of the call (call_control_id).

Example:

"v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ"

​
CallSidLegacy
string
required

Legacy call identifier, same as CallSid.

Example:

"v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ"

​
ConnectionId
string
required

The unique identifier of the connection.

Example:

"1234567890"

​
From
string
required

The phone number or SIP address of the caller.

Example:

"+35319605860"

​
To
string
required

The phone number or SIP address that was called.

Example:

"+13129457420"

​
CallerId
string

The display name of the caller (conditional, only present if caller_id_name is set).

Example:

"John Doe"

Response

200

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