Webhook

Eventmeldingen voor onder meer overdracht naar een medewerker, nieuwe berichten, het beëindigen van een gesprek, tickets en documentverwerking, plus regels voor handtekeningverificatie en opnieuw proberen.

Vul het webhook-adres in bij "Botinstellingen" in het beheerpaneel. Requestheaders:

HeaderUitleg
X-AICS-Event-IdEvent-ID, gebruik deze om te dedupliceren
X-AICS-Timestamp / X-AICS-SignatureDe verificatiemethode is dezelfde als bij Order lookup API

Requestbody: {"id", "type", "created_at", "data"}.

EventWanneer
conversation.handoffOverdracht naar een medewerker (wanneer bij de overdrachtsmethode "Naar mijn systeem pushen" of "Beide partijen informeren" is gekozen)
conversation.messageDe klant stuurt een nieuw bericht in de handmatige modus
conversation.closedHet gesprek is beëindigd (data.conversation.closed_by geeft aan wie het gesprek heeft beëindigd)
conversation.ratedDe klant heeft een beëindigd gesprek beoordeeld: data.rating, data.comment
ticket.createdNieuw ticket (inclusief berichten van klanten wanneer er geen medewerker online is): data.ticket, data.description
ticket.updatedWijzigingen in ticketstatus, prioriteit, toegewezen medewerker enz.: data.changes is {veld: [oud, nieuw]}
ticket.repliedEen medewerker heeft de klant geantwoord: data.reply
document.ready / document.failedDocumentverwerking voltooid of mislukt

Een 2xx-respons wordt als succesvol beschouwd; anders wordt er met backoff opnieuw geprobeerd na 30 seconden, 2 minuten, 10 minuten … tot maximaal 12 uur, in totaal 8 keer. De volgorde is niet gegarandeerd.

Was deze pagina nuttig?

Laatst bijgewerkt: