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
| Event | Wordt geactiveerd wanneer |
|---|---|
message.new | Er een nieuw bericht wordt verstuurd (door bezoeker of bot) |
session.started | Er een nieuwe gesprekssessie begint |
session.closed | Een gesprek wordt gesloten |
session.handoff | Een gesprek wordt overgedragen aan een menselijke medewerker |
lead.captured | Er een nieuwe lead wordt vastgelegd |
contact.created | Er een nieuw contact wordt aangemaakt |
ticket.created | Er een supportticket wordt geopend |
csat.submitted | Er een CSAT-beoordeling wordt ingediend |
Instellen
- Ga naar Dashboard -> Settings -> Webhooks.
- Klik op Add Webhook.
- Voer de URL van je endpoint in (moet HTTPS zijn).
- Selecteer de events die je wilt ontvangen.
- 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
- Genereer een API-sleutel via Dashboard -> Settings -> API Keys -> Create Key.
- Voeg deze toe aan de
Authorization-header:
Authorization: Bearer sk_your_api_key_here
Belangrijkste endpoints
| Methode | Endpoint | Omschrijving |
|---|---|---|
| GET | /api/chatbots | Alle chatbots weergeven |
| GET | /api/chatbots/:id | Details van een chatbot opvragen |
| GET | /api/sessions | Sessies weergeven (met filters) |
| GET | /api/sessions/:id/messages | Berichten van een sessie opvragen |
| POST | /api/sessions/:id/messages | Een bericht naar een sessie sturen |
| GET | /api/contacts | Contacten weergeven |
| POST | /api/contacts | Een contact aanmaken |
| GET | /api/leads | Leads weergeven |
| POST | /api/leads | Een lead aanmaken |
| GET | /api/analytics/overview | Samenvatting 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.