Skip to content
Talki DevelopersBeta

call.ringing

POST

An inbound call reached the assistant, which is about to pick up. Not every ring is followed by a Call: a caller who hangs up before the pickup, or a call nobody says anything on, leaves none. Sent to the account’s webhooks, and to an OAuth app that subscribes to it while its installation grants calls:read.

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters”
X-Talki-Signature
required
string

t=<unix seconds>,v1=<hex HMAC-SHA256>, the HMAC computed over <t>.<raw body> with the signing secret. During a secret rotation it carries one v1 per secret: accept the request if any matches.

X-Talki-Event
required
string

The event type, as in type.

X-Talki-Delivery
required
string

The event ID, as in id.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
id
required
Id

The event’s ID, evt_ and 32 hex characters. Equal to the X-Talki-Delivery header and unchanged on a redelivery: deduplicate on it.

string
type
required
string
Allowed values: call.ringing
created_at
required
Created At

When the event was written, ISO 8601 with a +00:00 offset, possibly with microseconds. Parse it as an instant.

string format: date-time
api_version
required
Api Version

The dated contract version data is shaped for: the endpoint’s version on a webhook, the app’s on an app event.

string
account_id
required
Account Id

The Talki account the event happened on.

string
livemode
required
Livemode

false for an event from a sandbox account.

boolean
origin
required
Any of:
EventOrigin
object
source
required
Source

Where the change came from: voice (the assistant, during a call), dashboard (a person in the Talki web or mobile app), api (a credential through the API) or system (a rule Talki applied on its own). New values may be added; treat one you do not recognise as unknown.

string
credential_id
required
Any of:
string
idempotency_key
required
Any of:
string
installation_id
Any of:
string
data
required

The event’s payload.

object
call_id
required
Call Id

The id the Call will have once it ends, which ties this event to the call.ended that follows. GET /v1/calls/{id} answers 404 until then.

string
location_id
required
Location Id

The location whose Talki number the caller dialled (GET /v1/locations).

string
caller
required
CallRingingCaller

Who is calling, as far as Talki may say.

object
contact_id
required
Any of:
string
phone_number
required
Any of:
string
display_name
required
Any of:
string
vip
required
Vip

Whether the number is on the VIP list of the call’s location (/v1/caller_rules). Never true without a number.

boolean
started_at
required
Started At

When the call arrived, RFC 3339 UTC. The Call’s started_at is the same.

string format: date-time
Example
{
  "id": "evt_04d8e87897db4ecab459a456ea55e754",
  "type": "call.ringing",
  "created_at": "2026-09-22T15:04:06.218734+00:00",
  "api_version": "2026-10-01",
  "account_id": "f7e39b9a-1ac8-45e4-93da-2600f17cb286",
  "livemode": true,
  "origin": {
    "source": "voice",
    "credential_id": null,
    "idempotency_key": null
  },
  "data": {
    "call_id": "b7a41f0e-3c52-4d18-9e6a-2f8c1d7e5a34",
    "location_id": "2c9e7b1a-6d40-4f35-8a12-9b3e5c7d1f60",
    "caller": {
      "contact_id": "8e1d3f5a-2b64-4c97-a0d8-6f4b2e9c7a15",
      "phone_number": "+393331112233",
      "display_name": "Mario Rossi",
      "vip": true
    },
    "started_at": "2026-09-22T15:02:11.482913Z"
  }
}

Responses

Section titled “ Responses ”

2XX

Section titled “2XX”

Any 2xx acknowledges the event. Any other status, a redirect, or no answer within 10 seconds is a failure and is retried; 410 disables a webhook endpoint at once.