| Wenn Sie eine Verbindung mit den APIs von Coachview realisieren, werden Sie zu bestimmten Zeiten, z.B. stündlich, Daten aus Coachview abrufen oder in Coachview schreiben. Mit einem Webhook, auch Reverse API genannt, ist es möglich, Daten aus Coachview zu "pushen". Das bedeutet, dass Coachview zu jedem Zeitpunkt eine Nachricht (Webhook) senden kann und dass auf Basis dieser Nachricht ein Follow-up in Ihrer Anwendung festgelegt werden kann. | ||||||||||||||||||||||||||||||||||||||||
Beispiel: | ||||||||||||||||||||||||||||||||||||||||
| Wenn eine Person in Coachview angelegt wird, kann ihr eine bestimmte Kategorie hinzugefügt werden. Der Wunsch ist es, von Ihrer Bewerbung an jede Person, die diese Kategorie hat, ein Dokument mit ihren Verantwortlichkeiten zu senden. Wenn Sie eine API verwenden, kann stündlich überprüft werden, ob es eine Person gibt, der die betreffende Kategorie hinzugefügt wurde. Auf der Grundlage der Antwort kann dann die nächste Aktion ausgeführt werden. Es kann also vorkommen, dass es 59 Minuten dauert, bis die Folgeaktion durchgeführt wird. Wenn Sie einen Webhook verwenden, wird automatisch eine Nachricht an Ihre Anwendung (URL) gesendet, wenn die Kategorie zu einer Person hinzugefügt wird. Die Folgemaßnahme kann dann sofort ausgeführt werden. | ||||||||||||||||||||||||||||||||||||||||
Erforderliche Informationen: | ||||||||||||||||||||||||||||||||||||||||
| Diese Informationen werden benötigt, um Webhooks zu aktivieren. | ||||||||||||||||||||||||||||||||||||||||
| URL: Der Webhook veranlasst Coachview, eine Nachricht auf der Grundlage eines bestimmten Ereignisses zu senden. Diese Nachricht wird an eine URL gesendet. Wir benötigen also die URL, an die diese Nachricht gesendet werden soll. Ein Beispiel ist: HTTPS://voorbeeldklant.nl Bei dieser URL ist es wichtig, dass der Port 443 verwendet wird. Dies ist der Standardport für HTTPS. Coachview unterstützt aus Sicherheitsgründen keinen anderen Port. Die Authentifizierung ist eine anonyme Authentifizierung. Coachview unterstützt keine grundlegende Authentifizierung. Wenn Sie mehrere Webhooks verwenden möchten, ist es möglich, dass diese an eine andere URL geliefert werden. Der Vorteil einer separaten URL pro Webhook ist, dass pro Webhook andere Einstellungen vorgenommen werden können. Denken Sie an personenbezogene Daten, Details und Unterschriften. Diese Einstellungen werden später in diesem Dokument erläutert. Mit separaten URLs wissen Sie außerdem genau, wann welcher Webhook eingetroffen ist. Daher ist es nicht mehr notwendig, einen zusätzlichen Filter/eine zusätzliche Prüfung hinzuzufügen. Abonnements Sie benötigen ein separates Abonnement, wenn Sie mehrere URLs, Token oder Signiergeheimnisse verwenden möchten. Für PII (Persönlich Identifizierbare Informationen) und Details benötigen Sie sie nicht. | ||||||||||||||||||||||||||||||||||||||||
Veranstaltung: | ||||||||||||||||||||||||||||||||||||||||
| Abgerufen von https://training.coachview.net/apidocs/swagger/index.html#/ finden Sie die verfügbaren Webhooks im Abschnitt "Webhooks". | ||||||||||||||||||||||||||||||||||||||||
 | ||||||||||||||||||||||||||||||||||||||||
| Dort sehen Sie eine Liste der Veranstaltungen. Wir möchten Sie bitten, uns den Namen der Veranstaltungen mitzuteilen, die Sie nutzen möchten. In dem genannten Beispiel würde dies bedeuten, dass Sie den Webhook "Personenkategorie hinzugefügt" benötigen. | ||||||||||||||||||||||||||||||||||||||||
 | ||||||||||||||||||||||||||||||||||||||||
Sicherheit: | ||||||||||||||||||||||||||||||||||||||||
| Es gibt zwei Methoden, um zu überprüfen, ob der Webhook von Coachview stammt: Unterschrift: Der http-Header 'x-coachview-whsignature' enthält eine Signatur/Signatur, die über die gesamte Nachricht mit HMAC-SHA256 und dem SigningSecret des Abonnements berechnet wird. Diese Signatur ist eine base64-Zeichenfolge. Token: Der http-Header 'x-coachview-whtoken' enthält das 'Token', das im Abonnement festgelegt wurde. Dies ist der gleiche Wert ohne Unterschrift oder Berechnung. Coachview liefert beides, so dass Sie selbst entscheiden können, welches Sie verwenden möchten. Die "Unterschrift" ist die sicherste Methode und wird auch von uns bevorzugt. Es liegt in Ihrer Verantwortung als Kunde, eine dieser beiden Optionen umzusetzen. | ||||||||||||||||||||||||||||||||||||||||
Personally Indentifiable Information (PII): | ||||||||||||||||||||||||||||||||||||||||
Der Webhook sendet mehrere Felder an die gewählte URL. Für die Felder, die mitgesendet werden, wird angegeben, ob diese mitgesendet werden müssen, wenn Sie PII aktiviert haben. Für jeden Webhook können Sie angeben, ob die als PII gekennzeichneten Felder zusammen mit dem Webhook gesendet werden sollen oder nicht. Für jeden Webhook müssen Sie angeben, ob Sie personenbezogene Daten einschließen wollen oder nicht. | ||||||||||||||||||||||||||||||||||||||||
Einzelheiten: | ||||||||||||||||||||||||||||||||||||||||
| Für die Einzelheiten gilt das Gleiche wie für personenbezogene Daten. Außerdem müssen Sie pro Webhook angeben, ob Sie Details ein- oder ausschließen wollen. Wenn Sie auf https://training.coachview.net/apidocs/swagger/index.html#/ Wenn Sie sich den fraglichen Webhook ansehen, können Sie sehen, welche Felder unter PII und unter Details angezeigt werden. | ||||||||||||||||||||||||||||||||||||||||
| Klicken Sie auf den Pfeil unter "Schemas" ganz unten auf dieser Seite, um die Übersicht anzuzeigen. |  | |||||||||||||||||||||||||||||||||||||||
| Scrollen Sie nach unten, bis Sie z. B. den Webhook "Eine neue Kategorie wurde einer Person hinzugefügt" sehen, und klicken Sie auf dessen Namen. | ||||||||||||||||||||||||||||||||||||||||
 | ||||||||||||||||||||||||||||||||||||||||
Bitte teilen Sie uns Folgendes mit: | ||||||||||||||||||||||||||||||||||||||||
| Bitte informieren Sie uns über die folgende zu verwendende API. | ||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||
Retry mechanisme. | ||||||||||||||||||||||||||||||||||||||||
| Wenn der Webhook gesendet wird und nicht zugestellt werden kann, wird der Webhook erneut gesendet. Wir versuchen, sie 12 Mal erneut zu senden. Insgesamt senden wir den Webhook also 13 Mal. Jedes Mal warten wir länger auf den nächsten Versuch. Zum Beispiel Angenommen, der Webhook wird heute um 11:45 Uhr gesendet. Wann werden sie erneut verschickt, wenn sie nicht zugestellt werden können?
| ||||||||||||||||||||||||||||||||||||||||
 | Hinweis: Bitte geben Sie den Status 200 (Erfolg) zurück, sobald der Webhook empfangen wurde. Und zwar nicht erst, wenn der Webhook vollständig verarbeitet ist. Coachview wartet nicht lange auf eine Antwort. Bei Fehlern wird auch ein 200 an den Webhook zurückgegeben, ansonsten wird der Webhook so lange wiederholt, bis er nach 10 Mal als fehlgeschlagen markiert wird. Coachview ergreift dann keine Maßnahmen. Es ist wichtig, dass Sie ein gültiges SSL-Zertifikat installiert haben! |
