Katalog zdarzeń

Każde ciało webhooka ma pole type, którego wartością jest jeden z typów zdarzeń na tej stronie. Gdy subskrybujesz endpoint, tablica events musi zawierać wybrane typy zdarzeń (lub być pusta, aby subskrybować wszystkie). Te zdarzenia są dostarczane na dwa sposoby:

Dostarczenia endpointu są zawsze nieblokującymi powiadomieniami z ponowieniami: odpowiedz dowolnym kodem 2xx; koperta zawiera event_id do deduplikacji.
Wymiany blokujące działają tylko w starszym webhooku z jednym adresem URL: żądanie konfiguracji telephony.incoming / web.incoming (numery w trybie webhooka i klucze widżetów, limit czasu 10 s) oraz wysyłanie narzędzi w trybie webhooka. Twoja odpowiedź kształtuje połączenie na żywo.

Poniższe przykładowe ładunki pokazują kopertę endpointu w kolejności przesyłania (klucze posortowane alfabetycznie: data, event_id, type); starsze dostarczenia zawierają te same data bez event_id.

Zdarzenia połączeń

`telephony.incoming`

Wysyłane, gdy połączenie przychodzące dociera na jeden z Twoich numerów telefonów. Dostarczenia do endpointu to powiadomienia typu fire-and-forget wysyłane dla każdego połączenia przychodzącego, niezależnie od tego, czy numer jest skonfigurowany dla agenta, czy dla webhooka. Numery bez przypisanego agenta dodatkowo otrzymują blokujące żądanie konfiguracji na starszym webhooku — pełny schemat żądania / odpowiedzi znajdziesz w telephony.incoming / web.incoming.

{
  "data": {
    "call_id": 987654321,
    "from_number": "+14155550199",
    "to_number": "+15551234567"
  },
  "event_id": "3f6b2ad0-1c9e-4a57-9f2b-8f6f0f9d2f11",
  "type": "telephony.incoming"
}

`telephony.complete`

Wysyłane po zakończeniu przychodzącego lub wychodzącego połączenia telefonicznego. Nieblokujące. Obejmuje transkrypcję, adres URL nagrania, gdy jest dostępny, oraz podsumowanie rozliczeń. Zobacz telephony.complete / web.complete, aby poznać schemat danych.

`telephony.tool`

Wysyłane po tym, jak połączenie telefoniczne wywoła narzędzie funkcji. Nieblokujące powiadomienie audytowe — narzędzie zostało już wykonane w chwili dostarczenia tego zdarzenia; obejmuje ono Twoje własne narzędzia funkcji (nie wbudowane narzędzia, narzędzia bazy wiedzy, połączeń aplikacji ani MCP).

{
  "data": {
    "arguments": { "date": "2026-04-21" },
    "call_id": 987654321,
    "from_number": "+14155550199",
    "response": {
      "response": { "available_slots": ["9:00 AM", "2:00 PM"] },
      "status": 200
    },
    "to_number": "+15551234567",
    "tool_name": "search_appointments"
  },
  "event_id": "1f0a7c3e-52d4-4a0e-8f4b-b1a6a1c0d9e2",
  "type": "telephony.tool"
}

response jest wynikiem wykonania: {"status": <http status>, "response": <your endpoint's JSON>} w przypadku powodzenia albo {"status": <status>, "error": "<message>"} w przypadku niepowodzenia.

`web.incoming`

Odpowiednik telephony.incoming dla kanału internetowego, wysyłany, gdy rozpoczyna się sesja widżetu internetowego lub testowe połączenie mikrofonowe w kreatorze. Dostarczenia do endpointu są typu fire-and-forget dla każdej sesji internetowej. Klucze publikowalne w mode="webhook" dodatkowo otrzymują blokujące żądanie konfiguracji na starszym webhooku — to blokujące żądanie ma inną strukturę (origin_domain, publishable_key_prefix; bez numerów telefonów). Zobacz telephony.incoming / web.incoming.

{
  "data": {
    "call_id": 987654322,
    "from_number": "web",
    "origin_domain": "https://example.com",
    "publishable_key_prefix": "pk_live_a1b2",
    "to_number": "+15551234567"
  },
  "event_id": "9a2b4c6d-8e0f-4a1b-9c2d-3e4f5a6b7c8d",
  "type": "web.incoming"
}

from_number zawsze ma literalną wartość "web". W przypadku sesji widżetu w trybie webhook to_number jest puste (numer agenta dla sesji jest przypisywany po konfiguracji); w przypadku testowych połączeń mikrofonowych w kreatorze origin_domain i publishable_key_prefix są puste.

`web.complete`

Odpowiednik telephony.complete dla kanału internetowego, obejmujący połączenia widżetu internetowego (direction: "web") oraz testowe połączenia mikrofonowe w kreatorze (direction: "test"). Nieblokujące. Taka sama struktura danych jak w telephony.complete, dodatkowo z origin_domain, przy czym from_number ma wartość "web".

W starszym webhooku z jednym adresem URL testowe połączenia mikrofonowe w kreatorze historycznie są raportowane jako telephony.complete — tylko połączenia z direction: "web" używają tam typu web.complete. System endpointów mapuje zarówno połączenia internetowe, jak i testowe na web.*. Historyczne dane mogą zawierać starsze wartości direction: widget lub mic.

`web.tool`

Odpowiednik telephony.tool dla kanału internetowego. data zawiera origin_domain zamiast from_number / to_number.

Zdarzenia głosowe

Tworzenie niestandardowego głosu jest asynchroniczne. Te nieblokujące zdarzenia umożliwiają reagowanie na wynik końcowy zamiast odpytywania punktu końcowego szczegółów klona.

`voice.ready`

Wysyłane, gdy niestandardowy głos zakończy przetwarzanie i można go przypisać do agenta.

{
  "data": {
    "voice": {
      "created_at": "2026-07-30T14:12:08.317Z",
      "display_name": "Support voice",
      "failure_reason": "",
      "gender": "female",
      "id": "cv_2f6f90b0e9a34ee8b39be7d1",
      "language": "en",
      "name": "custom:cv_2f6f90b0e9a34ee8b39be7d1",
      "status": "ready",
      "updated_at": "2026-07-30T14:13:31.605Z"
    }
  },
  "event_id": "2d5f0a61-e9b5-4a3c-b684-29d7d9e4b214",
  "type": "voice.ready"
}

`voice.failed`

Wysyłane, gdy przetwarzanie niestandardowego głosu zakończy się trwałym błędem.

{
  "data": {
    "reason": "audio sample could not be processed",
    "voice": {
      "created_at": "2026-07-30T14:12:08.317Z",
      "display_name": "Support voice",
      "failure_reason": "audio sample could not be processed",
      "gender": "female",
      "id": "cv_2f6f90b0e9a34ee8b39be7d1",
      "language": "en",
      "name": "custom:cv_2f6f90b0e9a34ee8b39be7d1",
      "status": "failed",
      "updated_at": "2026-07-30T14:13:31.605Z"
    }
  },
  "event_id": "3493e985-1a75-4f77-a10a-e74af440cd31",
  "type": "voice.failed"
}

Pole	Typ	Opis
`voice.id`	ciąg znaków	Publiczny identyfikator niestandardowego głosu
`voice.name`	ciąg znaków	Wartość głosu agenta w formacie `custom:<public_id>`
`voice.display_name`	ciąg znaków	Nazwa głosu widoczna dla organizacji
`voice.language`	ciąg znaków	Kod jedynego języka klona
`voice.gender`	ciąg znaków	`male`, `female` lub pusty ciąg znaków
`voice.status`	ciąg znaków	`ready` dla `voice.ready`; `failed` dla `voice.failed`
`voice.failure_reason`	ciąg znaków	Puste przy powodzeniu; szczegóły błędu przetwarzania przy niepowodzeniu
`voice.created_at`, `voice.updated_at`	znacznik czasu	Znaczniki czasu ISO 8601
`reason`	ciąg znaków	Szczegóły błędu; obecne tylko dla `voice.failed`

Zdarzenia jakości

`call.graded`

Wysyłane po zakończeniu uruchomienia oceny AI dla połączenia. Nie blokuje.

{
  "data": {
    "call_id": 987654321,
    "grade": {
      "call_outcome": "success",
      "created_at": "2026-04-20T18:25:11.002Z",
      "detected_issues": [],
      "graded_at": "2026-04-20T18:25:11.002Z",
      "grader_model": "heuristic-v1",
      "id": 5512,
      "score": 92,
      "status": "completed",
      "summary": "Caller asked about their policy and got a full answer…"
    }
  },
  "event_id": "7c1d2e3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f",
  "type": "call.graded"
}

Pole	Typ	Opis
`grade.id`	integer	Id oceny
`grade.score`	integer \| null	0–100
`grade.call_outcome`	string	`success`, `failure`, `unknown` lub `no_conversation`
`grade.summary`	string	Jednoakapitowe podsumowanie
`grade.detected_issues`	array	Ciągi opisujące problemy wykryte przez oceniający moduł
`grade.status`	string	Zawsze `completed` — emitowane są tylko zakończone uruchomienia
`grade.grader_model`	string	Moduł oceniający, który wygenerował wynik (np. `heuristic-v1`)
`grade.graded_at`, `grade.created_at`	timestamp

Połączenie może zostać ocenione więcej niż raz — po szybkiej ocenie heurystycznej często następuje pełna ocena modelu, gdy nagranie jest dostępne, a także możliwe są ręczne ponowne oceny. Każde zakończone uruchomienie emituje własne zdarzenie call.graded; jako autorytatywną traktuj najnowszą wartość graded_at.

`issue.reported`

Wysyłane, gdy tworzony jest raport problemu — zgłoszony przez użytkownika z panelu (source: "user") lub utworzony automatycznie przez ocenę połączenia (source: "system"). Nie blokuje.

{
  "data": {
    "call_id": 987654321,
    "issue_report": {
      "created_at": "2026-04-20T18:25:11.002Z",
      "description": "Five-second silence before responding to the main question.",
      "id": 4321,
      "severity": "warning",
      "source": "system",
      "status": "open",
      "title": "Agent paused too long"
    }
  },
  "event_id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
  "type": "issue.reported"
}

Pole	Typ	Opis
`issue_report.severity`	string	`critical`, `warning` lub `info`
`issue_report.status`	string	`open` lub `resolved`
`issue_report.source`	string	`user` (zgłoszone z panelu) lub `system` (utworzone przez ocenę)

Ponowna ocena połączenia odtwarza jego raporty problemów wygenerowane przez system, co ponownie emituje issue.reported dla odtworzonych raportów. Wykonaj deduplikację według call_id + title, jeśli chcesz otrzymywać tylko jedno powiadomienie na każdy podstawowy problem.

Zdarzenia połączeń testowych

`test-call.completed`

Wysyłane, gdy uruchomienie połączenia testowego osiągnie status końcowy — completed lub failed, w tym uruchomienia, które zakończyły się niepowodzeniem przy starcie i nigdy nie utworzyły połączenia. Nie blokuje. Przydatne do integracji wsadowych uruchomień CI z systemami czatu i powiadomień.

{
  "data": {
    "test_call_run": {
      "call_id": 987654321,
      "completed_at": "2026-04-20T18:25:04.822Z",
      "error_message": "",
      "id": 7110,
      "status": "completed",
      "target_id": 12,
      "target_type": "agent"
    }
  },
  "event_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
  "type": "test-call.completed"
}

Pole	Typ	Opis
`test_call_run.target_type`	string	`agent` lub `phone_number`
`test_call_run.target_id`	integer	Id agenta lub numeru telefonu, którego dotyczyło uruchomienie, zgodne z `target_type`
`test_call_run.status`	string	`completed` lub `failed`
`test_call_run.call_id`	integer \| null	`null`, gdy uruchomienie zakończyło się niepowodzeniem przed wykonaniem połączenia
`test_call_run.error_message`	string	Puste w przypadku powodzenia

Zdarzenia alertów

`alert.triggered`

Wysyłane, gdy reguła alertu z włączonym kanałem Dostarczaj do webhooków deweloperskich przekroczy swój próg. Nie blokuje działania. Reguła uruchamia się raz, a następnie uwzględnia okres wyciszenia, dlatego utrzymujące się naruszenie generuje jedno zdarzenie na każde okno wyciszenia.

{
  "data": {
    "comparator": "lt",
    "event_id": "b8e6a1d4-2c3f-4a5b-9c8d-7e6f5a4b3c2d",
    "fired_at": "2026-04-20T18:00:00+00:00",
    "metric": "success_rate",
    "metric_value": 71.4,
    "rule_id": "d2c3b4a5-6f7e-4d8c-9b0a-1c2d3e4f5a6b",
    "rule_name": "Success rate below 80%",
    "threshold": 80.0,
    "window_hours": 24
  },
  "event_id": "4d5e6f7a-8b9c-4d0e-9f1a-2b3c4d5e6f7a",
  "type": "alert.triggered"
}

Pole	Typ	Opis
`event_id` (w `data`)	UUID	Identyfikator uruchomienia alertu — różni się od `event_id` dostarczenia w kopercie
`rule_id`, `rule_name`	UUID, ciąg znaków	Reguła, która została uruchomiona
`metric`	ciąg znaków	`success_rate`, `failure_rate`, `avg_score`, `call_volume` lub `suite_regression`
`comparator`	ciąg znaków	`lt`, `lte`, `gt` lub `gte`
`metric_value`	liczba	Wartość metryki w oknie, gdy reguła została uruchomiona
`threshold`	liczba	Skonfigurowany próg
`window_hours`	liczba całkowita	Kroczące okno oceny
`fired_at`	znacznik czasu

Zobacz przewodnik po alertach, aby tworzyć reguły, metryki, okresy wyciszenia oraz kanały e-mail / Slack.

Powiązane

telephony.incoming / web.incoming

Blokujący ładunek połączenia przychodzącego, na który musisz odpowiedzieć.

telephony.complete / web.complete

Transkrypcja i metryki po zakończeniu połączenia.

Punkty końcowe webhooków

Zasubskrybuj adres URL dla podzbioru tych zdarzeń.

Narzędzia funkcji

Jak są generowane zdarzenia telephony.tool / web.tool.

Webhooks

Function Tools

Zdarzenia połączeń

`telephony.incoming`

`telephony.complete`

`telephony.tool`

`web.incoming`

`web.complete`

`web.tool`

Zdarzenia głosowe

`voice.ready`

`voice.failed`

Zdarzenia jakości

`call.graded`

`issue.reported`

Zdarzenia połączeń testowych

`test-call.completed`

Zdarzenia alertów

`alert.triggered`

Powiązane

telephony.incoming / web.incoming

telephony.complete / web.complete

Punkty końcowe webhooków

Narzędzia funkcji

​Zdarzenia połączeń

​telephony.incoming

​telephony.complete

​telephony.tool

​web.incoming

​web.complete

​web.tool

​Zdarzenia głosowe

​voice.ready

​voice.failed

​Zdarzenia jakości

​call.graded

​issue.reported

​Zdarzenia połączeń testowych

​test-call.completed

​Zdarzenia alertów

​alert.triggered

​Powiązane

telephony.incoming / web.incoming

telephony.complete / web.complete

Punkty końcowe webhooków

Narzędzia funkcji

Zdarzenia połączeń

`telephony.incoming`

`telephony.complete`

`telephony.tool`

`web.incoming`

`web.complete`

`web.tool`

Zdarzenia głosowe

`voice.ready`

`voice.failed`

Zdarzenia jakości

`call.graded`

`issue.reported`

Zdarzenia połączeń testowych

`test-call.completed`

Zdarzenia alertów

`alert.triggered`

Powiązane