Webhooki i API REST

Conviro udostępnia webhooki do powiadomień o zdarzeniach w czasie rzeczywistym oraz API REST do programowego dostępu do wszystkich funkcji platformy.

Webhooki

Czym są webhooki?

Webhooki wysyłają żądanie HTTP POST na Twój serwer za każdym razem, gdy w Conviro wystąpi określone zdarzenie. Dzięki temu możesz reagować w czasie rzeczywistym, bez odpytywania (polling).

Dostępne zdarzenia

Zdarzenie	Kiedy się uruchamia
`message.new`	Zostaje wysłana nowa wiadomość (przez odwiedzającego lub bota)
`session.started`	Rozpoczyna się nowa sesja rozmowy
`session.closed`	Rozmowa zostaje zamknięta
`session.handoff`	Rozmowa zostaje przekazana konsultantowi
`lead.captured`	Zostaje pozyskany nowy lead
`contact.created`	Zostaje utworzony nowy kontakt
`ticket.created`	Zostaje otwarte zgłoszenie do wsparcia
`csat.submitted`	Zostaje przesłana ocena CSAT

Konfiguracja

Przejdź do Dashboard -> Settings -> Webhooks.
Kliknij Add Webhook.
Podaj adres URL swojego endpointu (musi być HTTPS).
Wybierz zdarzenia, które chcesz otrzymywać.
Kliknij Save.

Bezpieczeństwo: podpisywanie HMAC-SHA256

Każdy ładunek webhooka jest podpisywany algorytmem HMAC-SHA256 przy użyciu Twojego sekretu webhooka. Zweryfikuj podpis na swoim serwerze, aby potwierdzić autentyczność:

X-Conviro-Signature: sha256=<hex_digest>

Porównaj ten nagłówek ze skrótem HMAC-SHA256 surowej treści żądania, obliczonym przy użyciu Twojego sekretu webhooka.

Zasady ponawiania

Jeśli Twój endpoint zwróci kod statusu inny niż 2xx, Conviro ponawia próbę maksymalnie 3 razy z wykładniczym opóźnieniem (1 min, 5 min, 30 min).

API REST

Uwierzytelnianie

Wygeneruj klucz API w Dashboard -> Settings -> API Keys -> Create Key.
Dołącz go do nagłówka Authorization:

Authorization: Bearer sk_your_api_key_here

Najważniejsze endpointy

Metoda	Endpoint	Opis
GET	`/api/chatbots`	Wyświetla listę wszystkich chatbotów
GET	`/api/chatbots/:id`	Pobiera szczegóły chatbota
GET	`/api/sessions`	Wyświetla listę sesji (z filtrami)
GET	`/api/sessions/:id/messages`	Pobiera wiadomości z sesji
POST	`/api/sessions/:id/messages`	Wysyła wiadomość do sesji
GET	`/api/contacts`	Wyświetla listę kontaktów
POST	`/api/contacts`	Tworzy kontakt
GET	`/api/leads`	Wyświetla listę leadów
POST	`/api/leads`	Tworzy lead
GET	`/api/analytics/overview`	Pobiera podsumowanie analityki

Limity zapytań

Plan Free: 60 zapytań/minutę
Starter: 120 zapytań/minutę
Pro: 300 zapytań/minutę
Growth+: 600 zapytań/minutę

Nagłówki z limitem zapytań są dołączane do każdej odpowiedzi:

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 298
X-RateLimit-Reset: 1672531200

Pełna dokumentacja

Odwiedź /developers, aby zobaczyć pełną dokumentację API z przykładami żądań i odpowiedzi.