---
title: "On-call event"
method: POST
path: "OnCallEvent"
tags: ["Call webhooks"]
---

# On-call event

`POST OnCallEvent` (webhook)

Sends a notification to track the lifecycle of an active call.status updates. It's triggered when a call is initiated, answered, and ends.

## Payload

- Call
  - `uuid` string, uuid, required — Call ID. Deprecated — use `id` instead.
  - `id` string, uuid, required — Call ID. Alias of `uuid`.
  - `direction` 'inbound' | 'outbound' — Direction of the call. One of `inbound` (call received by the account) or `outbound` (call placed by the account).
  - `event_type` 'call_setup' | 'ringing' | 'early_media' | 'answered' | 'completed' | 'busy' | 'cancelled' | 'rejected' | 'on_call_event', required — Most recent lifecycle event for the call. One of: - `call_setup` — the call is being initiated. - `ringing` — the destination is ringing. - `early_media` — early media (such as ringback) is playing before answer. - `answered` — the destination answered the call. - `completed` — the call ended normally. - `busy` — the destination was busy. - `cancelled` — the call was cancelled before answer. - `rejected` — the destination rejected the call. - `on_call_event` — an in-call event occurred (see `event_payload`).
  - `event_time` string, date-time, required — Date and time of the latest event in ISO 8601 format.
  - `event_payload` OnCallEventPayload, required — Payload for the `on_call_event` event type.
    - `type` 'audio' | 'collect', required — Type of in-call sub-event. One of `audio` (audio playback progress) or `collect` (DTMF digit collection progress).
    - `payload` object, nullable — Sub-event-specific data. Structure depends on the `type` field: - `audio`: `{ "status": "started" | "completed", "playback_id": "<uuid>" }` - `collect`: `{ "digits": "<digits>", "status": "started" | "completed" | "failed" }`
  - `from` string, required — Caller ID.
  - `to` string, required — Destination number.
  - `call_started` string, date-time, required — Date and time when the call started in ISO 8601 format.
  - `call_answered` string, date-time, nullable, required — Date and time when the call was answered in ISO 8601 format.
  - `call_completed` string, date-time, nullable, required — Date and time when the call ended in ISO 8601 format.
  - `machine_detected` boolean, required — Indicates whether the call was answered by a machine.
  - `tag` string, required — Call metadata

## Acknowledgement `200`

Return a 200 status to indicate that the data was successfully received

---

[API](https://skmtc.net/wavix/apis/wavix-apis.md) · [All operations](https://skmtc.net/wavix/apis/wavix-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wavix/wavix-apis/versions/b22f170488b6/schema)