Skip to main content
WEBHOOK
callReferStarted
{
  "data": {
    "record_type": "event",
    "event_type": "call.refer.started",
    "id": "fbeb70e0-54eb-4e26-8d19-56b43e66f754",
    "occurred_at": "2020-03-30T13:29:42.130013Z",
    "payload": {
      "call_control_id": "v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA",
      "call_leg_id": "817f7de8-728a-11ea-9ce6-02420a0f8969",
      "call_session_id": "817f8c2a-728a-11ea-9cbe-02420a0f8969",
      "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
      "connection_id": "1289082222292239760",
      "from": "+35319605860",
      "sip_notify_response": 100,
      "to": "+13129457420"
    }
  }
}

Headers

​
telnyx-timestamp
integer
required

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

​
telnyx-signature-ed25519
string
required

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

Body

application/json
​
data
object
Example:
{
  "record_type": "event",
  "event_type": "call.refer.started",
  "id": "fbeb70e0-54eb-4e26-8d19-56b43e66f754",
  "occurred_at": "2020-03-30T13:29:42.130013Z",
  "payload": {
    "call_control_id": "v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA",
    "call_leg_id": "817f7de8-728a-11ea-9ce6-02420a0f8969",
    "call_session_id": "817f8c2a-728a-11ea-9cbe-02420a0f8969",
    "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
    "connection_id": "1289082222292239760",
    "from": "+35319605860",
    "sip_notify_response": 100,
    "to": "+13129457420"
  }
}

Response

200

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