API en webhooks: koppel je helpdesk aan je eigen systemen
Een helpdesk API is een koppelvlak waarmee je eigen software tickets aanmaakt, leest en beantwoordt. Een webhook werkt andersom: het ticketsysteem roept jouw systeem aan als er iets gebeurt. SupportChannel heeft een publieke API met een sleutel per organisatie en uitgaande webhooks op gebeurtenissen zoals een nieuw ticket of een opgelost ticket.
- Publieke API, versie 1
- Een API-sleutel per organisatie
- Uitgaande webhooks op gebeurtenissen
- API als kanaal in elk plan
Wat kun je met de API?
Met de API maak je van elk systeem een supportkanaal. Je webwinkel, je app of je klantportaal maakt een ticket aan en het komt in dezelfde omnichannel inbox als je e-mail en chat. Je team antwoordt in SupportChannel en jouw systeem haalt het antwoord op of krijgt het via een webhook.
Wat zit erin?
- Publieke API. Bereikbaar onder /api/v1, met tickets als kern.
- Sleutel per organisatie. Je maakt API-sleutels aan in je instellingen. Een sleutel geeft alleen toegang tot je eigen organisatie.
- Uitgaande webhooks. SupportChannel stuurt een bericht naar jouw adres bij een gebeurtenis.
- Webhook als actie. Een regel in automatisering kan een webhook aanroepen als stap in de afhandeling.
Bij welke gebeurtenissen kan een webhook afgaan?
| Gebeurtenis | Wanneer |
|---|---|
| Ticket aangemaakt | Er is een nieuw ticket, via welk kanaal dan ook |
| Bericht ontvangen | Een klant heeft een bericht gestuurd |
| Bericht verstuurd | Een antwoord is de deur uit |
| Ticket gewijzigd | Status, prioriteit, toewijzing of tags zijn aangepast |
| Ticket opgelost | Het ticket staat op opgelost |
| Ticket heropend | Een klant is teruggekomen op een opgelost ticket |
| SLA dreigt of geschonden | Een deadline nadert of is verstreken |
Hoe begin je met de API?
Maak een API-sleutel aan
Doe dit in de instellingen van je organisatie en bewaar de sleutel veilig.
Maak een testticket
Stuur een ticket in via de API en bekijk het in je inbox.
Stel een webhook in
Geef het adres op waar SupportChannel gebeurtenissen naartoe stuurt.
Verwerk dubbele meldingen
Bouw je ontvanger zo dat dezelfde melding twee keer ontvangen geen kwaad kan.
Hoe betrouwbaar is de verwerking?
Inkomende berichten worden eerst vastgelegd en daarna verwerkt. Elk bericht heeft een eigen kenmerk per kanaal, waardoor hetzelfde bericht nooit twee keer als ticket binnenkomt. Wat niet verwerkt kan worden, staat in een foutwachtrij en geeft een melding. Meer over de bescherming van je gegevens lees je bij beveiliging.
Werk je met WHMCS, dan hoef je niets te bouwen: daarvoor is er een kant-en-klare WHMCS-koppeling.