Webhooki | ElevenLabs Documentation

Integracja Webhook Tool udostępnia twoje endpointy HTTP jako narzędzia, których twoja recepcja lub asystent firmowy mogą używać podczas rozmów. AI decyduje, kiedy wywołać endpoint na podstawie rozmowy.

Jak działają narzędzia webhook

Gdy tworzysz narzędzie webhook, określasz:

Endpoint HTTP do wywołania.
Opis jego działania, aby AI wiedziała, kiedy go użyć.
Parametry, które AI powinna zebrać podczas rozmowy.

Gdy podczas rozmowy jej treść odpowiada przeznaczeniu narzędzia, twoja recepcja zbiera parametry, wywołuje endpoint i używa odpowiedzi, aby kontynuować rozmowę.

Tworzenie narzędzia webhook

Przejdź do Integrations, wybierz Add integration, a następnie Webhook Tool. Skonfiguruj poniższe pola i wybierz Enable. Możesz dodać wiele narzędzi webhook.

Pole	Opis
Name	Nazwa narzędzia widoczna dla AI, na przykład `check_order_status`
Description	Kiedy i dlaczego używać tego narzędzia
Method	GET, POST, PUT, PATCH lub DELETE
URL	Twój endpoint HTTP
Response timeout (seconds)	Czas oczekiwania na twój serwer: 5–120 sekund, domyślnie 20
Assign to agents	Receptionist, Assistant agent lub oba
Disable interruptions	Uniemożliwia rozmówcy przerywanie działania narzędzia
Request Headers	Opcjonalne nagłówki wysyłane z każdym żądaniem. Type to Value lub Secret. Secret jest przechowywany w zaszyfrowanej formie i nigdy nie jest ponownie wyświetlany. Nagłówek pobrany z ElevenAgents może mieć typ Environment variable lub Variable z informacją, że jest ustawiony na platformie agentów.
Path Parameters	Wyświetlane, gdy URL zawiera symbole zastępcze w nawiasach klamrowych, np. `/orders/{order_id}`. Edytuj URL, aby dodać lub usunąć parametr.
Body Parameters	Parametry wysyłane jako treść żądania JSON, wyświetlane dla POST, PUT i PATCH. Mogą to być obiekty i listy.
Query Parameters	Parametry wysyłane jako ciągi zapytania URL. Każdy ma pojedynczą wartość.

Parametry

Każdy parametr ma:

Key: nazwa pola. Używaj liter, cyfr, podkreśleń, łączników, @ i pojedynczych kropek. Nawiasy kwadratowe nie są dozwolone, więc API oczekujące kluczy takich jak filter[name] nie może być wywołane bezpośrednio.
Type: string, number, integer lub boolean. Parametry treści mogą też mieć typ object lub array.
Value: From the conversation, uzupełniana przez AI, lub Fixed value, wysyłana z każdym żądaniem.
Description: wartość, którą AI powinna wyodrębnić z rozmowy.
Required: czy AI musi ją zebrać przed wywołaniem.

Używaj integer dla liczb całkowitych, takich jak liczby, identyfikatory oraz flagi 0/1. Stała wartość typu number jest wysyłana z kropką dziesiętną, więc 1 dociera jako 1.0, co niektóre API odrzucają.

Parametr skonfigurowany w ElevenAgents tak, aby pobierał wartość ze zmiennej, jest wyświetlany jako tylko do odczytu z informacją, że jest ustawiony na platformie agentów. Jest wysyłany zgodnie z konfiguracją na tej platformie.

Obiekty i listy

Wiele API oczekuje powiązanych pól zgrupowanych razem, np. kontaktu z listą numerów telefonu. Parametry treści mogą je wysyłać:

object grupuje pola. Wybierz Add field, aby dodać każde z nich; każde pole ma własny klucz, typ i wartość.
array to lista. W sekcji Each item wybierz typ jej elementów. Lista obiektów pozwala AI wysłać kilka wpisów o tej samej strukturze, np. po jednym dla każdego numeru telefonu.

Pola można zagnieżdżać do pięciu poziomów. Obiekt lub lista zawsze pochodzi z rozmowy, ale pole w obiekcie może mieć Fixed value, np. etykietę lub ID, które nigdy się nie zmienia.

Na przykład te parametry treści:

name: string, z rozmowy
phones: array, gdzie każdy element jest obiektem z dwoma polami:
- number: string, z rozmowy
- label: string, stała wartość mobile
source: obiekt z jednym polem, channel: string, stała wartość phone

wysyłają treść żądania taką jak ta:

{
  "name": "Jane Doe",
  "phones": [{ "number": "+15551234567", "label": "mobile" }],
  "source": { "channel": "phone" }
}

Przypadki użycia

Scenariusz	Opis	Metoda
Wyszukiwanie w CRM	Wyszukiwanie informacji o kliencie w twoim systemie	GET
Sprawdzanie zapasów	Sprawdzanie dostępności produktu w czasie rzeczywistym	GET
Zbieranie leadów	Wysyłanie danych rozmówcy do systemu marketingowego	POST
Tworzenie zgłoszeń	Tworzenie zgłoszenia do pomocy podczas rozmowy	POST
Wycena	Obliczanie indywidualnej wyceny na podstawie wymagań rozmówcy	POST

Przykład

Firma hydrauliczna tworzy narzędzie webhook:

Name: check_service_area
Description: “Sprawdź, czy obsługujemy kod pocztowy rozmówcy i jaki jest najbliższy dostępny termin.”
URL: https://api.mybusiness.com/check-area
Method: POST
Request Headers: Authorization ustawiony na klucz API firmy jako Secret
Body Parameters: zip_code (string, wymagany), service_type (string, wymagany)

Gdy rozmówca pyta o usługi w swojej okolicy, recepcja zbiera jego kod pocztowy, wywołuje webhook i przekazuje wynik.

Narzędzia webhook są dostępne w każdym planie.