Webhooks en REST API

Channels & Integrations6 weergaven

Webhooks en REST API

Conviro biedt webhooks voor realtime meldingen van events en een REST API voor programmatische toegang tot alle functies van het platform.

Webhooks

Wat zijn webhooks?

Webhooks sturen een HTTP POST-verzoek naar je server zodra er een bepaald event plaatsvindt in Conviro. Zo reageer je in realtime, zonder te pollen.

Beschikbare events

EventWordt geactiveerd wanneer
message.newEr een nieuw bericht wordt verstuurd (door bezoeker of bot)
session.startedEr een nieuwe gesprekssessie begint
session.closedEen gesprek wordt gesloten
session.handoffEen gesprek wordt overgedragen aan een menselijke medewerker
lead.capturedEr een nieuwe lead wordt vastgelegd
contact.createdEr een nieuw contact wordt aangemaakt
ticket.createdEr een supportticket wordt geopend
csat.submittedEr een CSAT-beoordeling wordt ingediend

Instellen

  1. Ga naar Dashboard -> Settings -> Webhooks.
  2. Klik op Add Webhook.
  3. Voer de URL van je endpoint in (moet HTTPS zijn).
  4. Selecteer de events die je wilt ontvangen.
  5. Klik op Save.

Beveiliging: ondertekening met HMAC-SHA256

Elke webhook-payload wordt ondertekend met HMAC-SHA256 op basis van je webhook secret. Controleer de handtekening op je server om de echtheid vast te stellen:

X-Conviro-Signature: sha256=<hex_digest>

Vergelijk deze header met de HMAC-SHA256-digest van de ruwe request body, berekend met je webhook secret.

Herhaalbeleid

Als je endpoint een statuscode buiten de 2xx-reeks teruggeeft, probeert Conviro het maximaal 3 keer opnieuw met exponentiële backoff (1 min, 5 min, 30 min).


REST API

Authenticatie

  1. Genereer een API-sleutel via Dashboard -> Settings -> API Keys -> Create Key.
  2. Voeg deze toe aan de Authorization-header:
Authorization: Bearer sk_your_api_key_here

Belangrijkste endpoints

MethodeEndpointOmschrijving
GET/api/chatbotsAlle chatbots weergeven
GET/api/chatbots/:idDetails van een chatbot opvragen
GET/api/sessionsSessies weergeven (met filters)
GET/api/sessions/:id/messagesBerichten van een sessie opvragen
POST/api/sessions/:id/messagesEen bericht naar een sessie sturen
GET/api/contactsContacten weergeven
POST/api/contactsEen contact aanmaken
GET/api/leadsLeads weergeven
POST/api/leadsEen lead aanmaken
GET/api/analytics/overviewSamenvatting van de analytics opvragen

Rate limits

  • Free-abonnement: 60 verzoeken/minuut
  • Starter: 120 verzoeken/minuut
  • Pro: 300 verzoeken/minuut
  • Growth+: 600 verzoeken/minuut

De rate limit-headers zitten in elke response:

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

Volledige documentatie

Ga naar /developers voor de volledige API-referentie met voorbeelden van requests en responses.

webhookapiresthmacintegrationendpointsdeveloper

Was dit artikel nuttig?