Hoe integreer ik Rinkel met mijn systemen via webhooks?


Rinkel collega Janine
Janine Wilbrink
update: 21 augustus 2023

Let op: webhooks zijn technisch. We raden sterk aan om een developer in te huren (of te zijn), of een IT-achtergrond te hebben om webhooks te implementeren in je bestaande tools. Natuurlijk ben je welkom om ermee te experimenteren en tijd te investeren om webhooks te onderzoeken als je (nog) geen IT-achtergrond hebt.

In deze FAQ zullen we de volgende vragen beantwoorden:

  • Waarom heb ik een webhook nodig?

  • Hoe stel ik een webhook in?

  • Welke gegevens worden verzonden in een webhook?

  • Welke beveiligingsmaatregelen zijn er voor webhooks?

  • Wat moet ik doen als mijn webhook niet werkt?

Je vindt webhooks in de Webphone.


Waarom heb ik een webhook nodig?

Webhooks zijn een efficiënte manier om verschillende services te integreren met My Rinkel. Door gebruik te maken van webhooks kun je automatisch bepaalde acties of updates triggeren in je andere tools (zoals een CRM, helpdesk of reporting) op basis van gespreksactiviteiten in My Rinkel.

Bijvoorbeeld: als je een nieuwe inkomende oproep ontvangt, kan een webhook direct deze gegevens naar jouw URL-eindpunt sturen, dat vervolgens automatisch een nieuw ticket in je helpdesksysteem aanmaakt.


Hoe stel ik een webhook in?

Om een webhook in te stellen, moet je een URL-eindpunt specificeren in je applicatie waar Rinkel de gegevens naartoe kan sturen. Dit eindpunt moet toegankelijk zijn via internet en in staat zijn om POST-verzoeken te ontvangen. Nadat je het eindpunt hebt ingesteld, kun je de URL ervan aan Rinkel doorgeven via de Webphone, door de volgende stappen te volgen:

  1. Ga naar de Rinkel Webphone

  2. Klik op het tandwiel icoon linksboven en ga naar Integraties

  3. Klik op de webhook die je wilt instellen (inkomende oproepen, uitgaande oproepen, begin van een oproep of einde van een oproep)

  4. Voer de URL van je eindpunt in

  5. Klik op test URL om te controleren of de URL geldig is

  6. Voeg een beschrijving van de webhook toe (optioneel)

  7. Klik op Opslaan om je wijzigingen op te slaan

Zorg ervoor dat je verzoeken van het Rinkel-domein toestaat om de webhookmeldingen succesvol te ontvangen.


Welke gegevens worden verzonden in een webhook?

Rinkel heeft 4 webhooks gecreëerd, die momenteel dezelfde webhook zijn die wordt gebruikt voor onze Zapier-integratie:

  • Inkomende oproepen

  • Uitgaande oproepen

  • Begin van een oproep

  • Einde van een oproep

Inkomende oproepen:

Deze webhook wordt geactiveerd wanneer er een inkomende oproep is gemaakt maar nog niet is beantwoord.

  • id: Het unieke ID van de oproep

  • datetime: De datum en tijd van de oproep

  • to: Het nummer van de beller

  • from: Het telefoonnummer dat is gebeld

Uitgaande oproepen:

Deze webhook wordt geactiveerd wanneer je een oproep maakt vanaf je zakelijke Rinkel nummer, maar de oproep nog niet is beantwoord.

  • id: Het unieke ID van de oproep

  • datetime: De datum en tijd van de oproep

  • to: Het nummer van de beller

  • from: Het telefoonnummer dat is gebeld

Begin van een oproep:

Deze webhook wordt geactiveerd op het moment dat jij of een collega de inkomende oproep beantwoordt, of op het moment dat de persoon die je probeert te bellen de telefoon oppakt.

  • id: Het unieke ID van de oproep

  • datetime: De datum en tijd van de oproep

  • answeredBy: De gebruiker die de oproep heeft beantwoord (weergegeven door een uniek gebruikers-ID)

  • choice: Elke keuze gemaakt in het spraakmenu (alleen beschikbaar voor inkomende oproepen)

Einde van een oproep:

Deze webhook wordt geactiveerd wanneer een oproep eindigt, om een van de zes beschikbare redenen.

  • id: Het unieke ID van de oproep

  • datetime: De datum en tijd van de oproep

  • cause: De reden waarom de oproep is beëindigd (6 opties: onbeantwoord, beantwoord, geblokkeerd, voicemail, callcenter, buiten bedrijfstijden)


Welke beveiligingsmaatregelen zijn er voor webhooks?

Webhooks zijn beveiligd via verschillende mechanismen. De gegevens die door de webhook worden verzonden, zijn in JSON-formaat, wat een veelgebruikt, leesbaar gegevensformaat is dat gemakkelijk kan worden beveiligd.

De communicatie tussen Rinkel en jouw applicatie verloopt via HTTPS, waardoor de gegevens tijdens de overdracht worden versleuteld.

Bovendien moet je alleen verzoeken accepteren van betrouwbare bronnen, zoals het Rinkel-domein.


Wat moet ik doen als mijn webhook niet werkt?

Als je webhook niet naar verwachting functioneert, volg dan deze veelvoorkomende stappen om het probleem op te lossen:

  1. Controleer je eindpunt: Zorg ervoor dat de URL van je eindpunt correct is en toegankelijk is via internet.

  2. Controleer de HTTP-methode: Bevestig dat je eindpunt is ingesteld om POST-verzoeken te ontvangen.

  3. Onderzoek het verzoek en de respons: Gebruik tools om het inkomende verzoek vast te leggen en te controleren op fouten. Zorg er ook voor dat je applicatie een succesvolle HTTP-statuscode (200 OK) retourneert om de ontvangst van de gegevens te bevestigen.

  4. Controleer het domein van Rinkel: Zorg ervoor dat je verzoeken van het Rinkel-domein accepteert.

Als je nog steeds problemen hebt, kopieer dan de foutmeldingen die je ontvangt en stuur ze naar het ondersteuningsteam van Rinkel. We helpen je graag bij het oplossen van het probleem.