realtime.call.incoming
Sent when an incoming API SIP session is available for Realtime acceptance. The same pending session can also emit live.transport.incoming; the first successful Realtime or Live accept endpoint selects the runtime surface.
Schema
Schema name: WebhookRealtimeCallIncoming
json
{
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/webhooks/realtime_call_incoming/post/requestBody/content/application%2Fjson/schema",
"docstring": "Sent when an incoming API SIP session is available for Realtime acceptance.\nThe same pending session can also emit `live.transport.incoming`; the first\nsuccessful Realtime or Live accept endpoint selects the runtime surface.\n",
"ident": "RealtimeCallIncomingWebhookEvent",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "created_at"
},
{
"ident": "data"
},
{
"ident": "type"
},
{
"ident": "object"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) id",
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) created_at",
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) data",
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) type",
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) object"
]
},
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"oasRef": "#/components/schemas/WebhookRealtimeCallIncoming/properties/id",
"deprecated": false,
"key": "id",
"docstring": "The unique ID of the event.\n",
"type": {
"kind": "HttpTypeString"
},
"optional": false,
"nullable": false,
"schemaType": "string",
"children": []
},
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) created_at": {
"kind": "HttpDeclProperty",
"oasRef": "#/components/schemas/WebhookRealtimeCallIncoming/properties/created_at",
"deprecated": false,
"key": "created_at",
"docstring": "The Unix timestamp (in seconds) of when the model response was completed.\n",
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"format": "unixtime"
},
"optional": false,
"nullable": false,
"schemaType": "integer",
"children": []
},
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) data": {
"kind": "HttpDeclProperty",
"oasRef": "#/components/schemas/WebhookRealtimeCallIncoming/properties/data",
"deprecated": false,
"key": "data",
"docstring": "Event data payload.\n",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "call_id"
},
{
"ident": "sip_headers"
}
]
},
"optional": false,
"nullable": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) data > (property) call_id",
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) data > (property) sip_headers"
]
},
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"oasRef": "#/components/schemas/WebhookRealtimeCallIncoming/properties/type",
"deprecated": false,
"key": "type",
"docstring": "The type of the event. Always `realtime.call.incoming`.\n",
"type": {
"kind": "HttpTypeUnion",
"oasRef": "#/components/schemas/WebhookRealtimeCallIncoming/properties/type",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "realtime.call.incoming"
}
]
},
"optional": false,
"nullable": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) type > (member) 0"
]
},
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) object": {
"kind": "HttpDeclProperty",
"oasRef": "#/components/schemas/WebhookRealtimeCallIncoming/properties/object",
"deprecated": false,
"key": "object",
"docstring": "The object of the event. Always `event`.\n",
"type": {
"kind": "HttpTypeUnion",
"oasRef": "#/components/schemas/WebhookRealtimeCallIncoming/properties/object",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "event"
}
]
},
"optional": true,
"nullable": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) object > (member) 0"
]
},
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) data > (property) call_id": {
"kind": "HttpDeclProperty",
"oasRef": "#/components/schemas/WebhookRealtimeCallIncoming/properties/data/properties/call_id",
"deprecated": false,
"key": "call_id",
"docstring": "The Transceiver `rtc_...` ID of the pending SIP session. The paired\n`live.transport.incoming` event derives its `session_id` by replacing the\n`rtc_` prefix with `live_`. Use the ID returned by the event with the\ncorresponding Realtime or Live API.\n",
"type": {
"kind": "HttpTypeString"
},
"optional": false,
"nullable": false,
"schemaType": "string",
"children": []
},
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) data > (property) sip_headers": {
"kind": "HttpDeclProperty",
"oasRef": "#/components/schemas/WebhookRealtimeCallIncoming/properties/data/properties/sip_headers",
"deprecated": false,
"key": "sip_headers",
"docstring": "Headers from the SIP INVITE, excluding SIP authorization headers.\nRetained names, values, repeated entries, and order are preserved.\nTreat these values as untrusted call metadata.\n",
"type": {
"kind": "HttpTypeArray",
"oasRef": "#/components/schemas/WebhookRealtimeCallIncoming/properties/data/properties/sip_headers",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "value"
}
]
}
},
"optional": false,
"nullable": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) data > (property) sip_headers > (items) > (property) name",
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) data > (property) sip_headers > (items) > (property) value"
]
},
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "realtime.call.incoming"
}
},
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) object > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "event"
}
},
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) data > (property) sip_headers > (items) > (property) name": {
"kind": "HttpDeclProperty",
"oasRef": "#/components/schemas/WebhookRealtimeCallIncoming/properties/data/properties/sip_headers/items/properties/name",
"deprecated": false,
"key": "name",
"docstring": "Name of the SIP Header.\n",
"type": {
"kind": "HttpTypeString"
},
"optional": false,
"nullable": false,
"schemaType": "string",
"children": []
},
"(resource) webhooks > (model) realtime_call_incoming_webhook_event > (schema) > (property) data > (property) sip_headers > (items) > (property) value": {
"kind": "HttpDeclProperty",
"oasRef": "#/components/schemas/WebhookRealtimeCallIncoming/properties/data/properties/sip_headers/items/properties/value",
"deprecated": false,
"key": "value",
"docstring": "Value of the SIP Header.\n",
"type": {
"kind": "HttpTypeString"
},
"optional": false,
"nullable": false,
"schemaType": "string",
"children": []
}
}Example
json
{
"id": "evt_abc123",
"type": "realtime.call.incoming",
"created_at": 1719168000,
"data": {
"call_id": "rtc_479a275623b54bdb9b6fbae2f7cbd408",
"sip_headers": [
{"name": "Max-Forwards", "value": "63"},
{"name": "CSeq", "value": "851287 INVITE"},
{"name": "Content-Type", "value": "application/sdp"}
]
}
}