Webhook einrichten

Sobald ein Projekt fertig erfasst wurde und der Kunde auf "speichern" oder "check starten" klickt, wird der Webhook angesprochen.

Webhook Adresse einrichten

Im Business Account unter Einstellungen kann im Punkt API-Schnittstelle die Webhookadresse und ein Webhook Auth hinterlegt werden.

Die Webhook Adresse wird angesprochen, sobald das Projekt fertiggestellt wird. Der Webhook Auth kann ein beliebiger Key sein, der bei jedem Event an den Webhook gesendet wird. Dieser kann zur Authentifizierung genutzt werden.

Webhook Request

An die Webhook Adresse wird folgendes JSON gesendet:

{
  "event":"webhookcheck",    //das ausgelöste event (webhookcheck oder webhooksave)
  "authenticate":"XYZ",      //eigener Key zur Authentifizierung
  "projektKey":"xxxxxxxxx"   //der 9-stellige Projekt Key des Projektes
}

Events

Es werden zwei unterschiedliche Events ausgelöst. Je nachdem welche Einstellung im Business Account hinterlegt ist, kann der Kunde das Projekt nur speichern oder zusätzlich auch den Check laden.

1. Kunde speichert das Projekt (webhooksave)
2. Kunde lädt, den check zu dem Projekt (webhookcheck)