Contact Support

Erstellen von Webhooks

Aktualisiert

Webhooks bieten eine leistungsstarke Möglichkeit, Echtzeit-Updates von Ihrer Awardco-Plattform zu erhalten und ermöglichen eine nahtlose Integration mit Ihren anderen Anwendungen. Im Gegensatz zu herkömmlichen APIs, bei denen Sie ständig nach neuen Informationen suchen müssen, senden Webhooks automatisch Daten an den von Ihnen angegebenen Ort, sobald ein relevantes Ereignis in Awardco eintritt. So haben Sie immer die aktuellsten Informationen ohne Verzögerungen.

Derzeit konzentriert sich unser Webhooks-Feature auf Recognition-Ereignisse, was bedeutet, dass Sie sofort Daten zu Anerkennungen erhalten können, sobald diese in Awardco stattfinden. Diese Daten umfassen Details wie den Geber, Empfänger, Punktzahl, Anerkennungsnotiz und den Programmnamen. Dieser Artikel führt Sie durch die Erstellung, Konfiguration und Verwaltung von Webhooks, um Anerkennungsdaten von Ihrer Awardco-Plattform mit Ihrem gewünschten Endpunkt zu synchronisieren.

 

  1. Anwendungsfälle für Webhooks 
  2. Navigation zum Webhook-Ersteller
  3. Erstellen eines Webhooks
  4. Verwalten von Webhooks
  5. FAQ

 

Anwendungsfall für Webhooks 

Webhooks ermöglichen es Ihrer Organisation, Echtzeit-Anerkennungs-Updates auf externen sozialen Feeds anzuzeigen, wie beispielsweise einem unternehmensinternen Intranet.

Im Gegensatz zur Verbindung über Feed-API-Aufrufe erfolgt der Prozess bei Webhooks sofort. Sobald eine Anerkennung in Ihrer Awardco-Plattform eingereicht wird, wird der Webhook ausgelöst, und die Anerkennungsdaten werden sofort an Ihren angegebenen Endpunkt gesendet, was sofortige Aktualisierungen auf Ihren externen Feeds ermöglicht.

 

Navigation zum Webhook-Ersteller

Um mit dem Erstellen und Verwalten von Webhooks zu beginnen:

  1. Melden Sie sich bei Ihrer Anerkennungsplattform an.
  2. Wählen Sie auf der Startseite die Schaltfläche Admin unten im linken Navigationsmenü.
  3. Wählen Sie „Plattform“, dann „Integrationen“ und anschließend „Webhooks“ im linken Navigationsmenü.

Auf der Seite „Webhooks“ sehen Sie eine Liste aller vorhandenen Webhooks. Um einen neuen zu erstellen, klicken Sie auf die Schaltfläche Webhook erstellen.

 

 

 

Erstellen eines Webhooks

Wenn Sie auf „Webhook erstellen“ klicken, erscheint ein Modal, in dem Sie Ihren neuen Webhook konfigurieren können. Hier eine Übersicht der einzelnen Felder:

  • Name: Geben Sie Ihrem Webhook einen aussagekräftigen Namen. Dies hilft Ihnen später bei der Identifizierung, insbesondere wenn Sie mehrere Webhooks haben.
  • Auslöseereignisse: Dieses Dropdown enthält derzeit eine Option: Anerkennung abgeschlossen. Das bedeutet, Ihr Webhook wird aktiviert, sobald eine Anerkennung erfolgreich in Awardco gesendet wird. Wir sind offen dafür, basierend auf Kundenwünschen weitere Auslöseereignisse hinzuzufügen.
  • Endpunkt-URL: Dies ist die URL, an die die Anerkennungsdaten gesendet werden. Sie sind verantwortlich für die Bereitstellung dieser URL. Dies ist der „Ort“, mit dem Ihr Webhook kommuniziert.
  • Geheimer Schlüssel: Dies ist eine automatisch generierte Sicherheitsmaßnahme. Wenn eine Webhook-Anfrage von Awardco gesendet wird, verwenden Sie diesen geheimen Schlüssel, um eine Signatur zu erstellen. Diese Signatur wird dann mit einer von Awardco gesendeten Signatur verglichen. Stimmen sie überein, wird bestätigt, dass die Daten tatsächlich von Awardco stammen und nicht von einer bösartigen Drittpartei. Für technische Details zur Erstellung dieser Signatur siehe den Abschnitt „Webhook-Verifizierung“ in unserer API-Dokumentation.
  • Fehler-Empfänger-E-Mails: Wenn Probleme bei der Zustellung der Daten durch Ihren Webhook auftreten, werden Fehlerprotokolle an die hier aufgeführten E-Mail-Adressen gesendet. Sie können mehrere E-Mail-Adressen durch Kommas getrennt hinzufügen.
  • Status: Stellen Sie diesen Schalter auf Aktiv, damit Ereignisdaten bei Auftreten des Auslöseereignisses geliefert werden. Bei Inaktiv wird der Webhook pausiert.
  • Test ausführen: Klicken Sie auf diese Schaltfläche, um Dummy-Daten einer Anerkennung an Ihre angegebene Endpunkt-URL zu senden. So können Sie überprüfen, ob Ihr Webhook korrekt eingerichtet ist, bevor er mit echten Daten live geht. Denken Sie daran, nach dem Test alle Testanerkennungen, die in Ihrem externen Feed erscheinen, zu löschen.

 

 

 

Verwalten von Webhooks

Nachdem Sie einen Webhook erstellt haben, können Sie ihn auf der Hauptseite „Webhooks“ verwalten. Neben jedem Webhook finden Sie ein Drei-Punkte-Menü mit den folgenden Optionen:

  • Details anzeigen: Diese Option zeigt allgemeine Informationen über den Webhook an, einschließlich der Möglichkeit, den geheimen Schlüssel zu kopieren.
  • Bearbeiten: Hiermit gelangen Sie zurück zum Erstellungsmodal, wo Sie alle Einstellungen des Webhooks ändern können.
  • Test ausführen: Ähnlich wie die Schaltfläche „Test ausführen“ während der Erstellung sendet diese Dummy-Daten an Ihre Endpunkt-URL, um sicherzustellen, dass der Webhook wie erwartet funktioniert.
  • Inaktiv setzen: Dies pausiert den Webhook, sodass er nicht mehr ausgelöst wird und keine Daten sendet.
  • Aktiv setzen: (Nur sichtbar, wenn der Webhook inaktiv ist) Dies aktiviert den Webhook wieder, sodass er erneut ausgelöst werden kann.
  • Löschen: Dies entfernt den Webhook dauerhaft.

 

 

 

FAQ

  • F: Was ist der Unterschied zwischen Webhooks und APIs?
    • A: APIs erfordern in der Regel, dass Sie Anfragen stellen, um Daten abzurufen. Webhooks hingegen sind „ereignisgesteuert“, das heißt, sie senden automatisch Daten an Ihren angegebenen Endpunkt, sobald ein bestimmtes Ereignis (wie das Senden einer Anerkennung) eintritt. Das macht Webhooks ideal für Echtzeit-Updates.
  • F: Kann ich Webhooks für andere Ereignisse als „Anerkennung abgeschlossen“ erhalten?
    • A: Derzeit ist „Anerkennung abgeschlossen“ das einzige verfügbare Auslöseereignis. Wir prüfen, in Zukunft weitere Auslöseereignisse hinzuzufügen. Wenn Sie einen speziellen Anwendungsfall haben, wenden Sie sich bitte an Ihren Awardco-Ansprechpartner.
  • F: Wo finde ich weitere technische Dokumentation zu Webhooks?
    • A: Unsere API-Dokumentation enthält einen eigenen Abschnitt zu Webhooks, der technische Details bietet, einschließlich Informationen zur Generierung einer Signatur aus Ihrem geheimen Schlüssel zur Webhook-Verifizierung. Während der Beta-Phase ist diese Seite direkt unter folgender URL erreichbar: https://api.awardco.com/api/webhooks




 

If you have any questions, please contact Awardco Admin Support.

Verknüpfung mit