API Reference

Receiving Events

call.incomingbeta

This feature is in private beta. Contact technical support to request access for your workspace.

call.incoming is a reserved private-beta contract, not an available incoming-call feature. When enabled, beta workspaces can receive it through a matching subscribed_events entry, * or an empty/omitted list.

Event payload

{
  "id": "evt_call_example",
  "type": "call.incoming",
  "provider": "whatsapp",
  "account_id": "acc_example",
  "occurred_at": "2026-10-10T12:00:42Z",
  "data": {
    "call": {
      "id": "call_example",
      "direction": "inbound",
      "media_type": "voice",
      "state": "ringing"
    },
    "sender": {
      "id": "100000000000002@lid",
      "display_name": "Example"
    },
    "join_url": "https://calls.example.com/call/call_example?ticket=EXAMPLE"
  }
}

Notes

  • call.incoming is a reserved private-beta contract, not an available incoming-call feature. When enabled, beta workspaces can receive it through a matching subscribed_events entry, * or an empty/omitted list.
  • Standard workspaces must explicitly list call.answered and call.ended in subscribed_events to receive outbound events. Beta workspaces can also use *, an empty list, or an omitted list. Delivery, retry, and dead-letter replay check the current eligibility and subscription. message.* call records are independent.