Integrationen, APIs und Webhooks Automatisiere Arbeitsabläufe und synchronisiere Daten mühelos mit den APIs und Echtzeit-Webhooks von idloom.

Einführung

Die APIs und Webhooks von idloom bieten leistungsstarke Tools zur Automatisierung von Arbeitsabläufen und zur Integration mit externen Systemen. Durch die Nutzung der APIs können Benutzer Daten zwischen idloom und anderen Softwarelösungen nahtlos synchronisieren, was den Prozess des Eventmanagements effizienter macht. Webhooks hingegen ermöglichen Echtzeit-Trigger, die automatisch bestimmte Aktionen oder Benachrichtigungen auslösen, wenn bestimmte Ereignisse auf der Plattform stattfinden.

Diese Funktionen eignen sich ideal für Eventorganisatoren, Entwickler und IT-Administratoren, die die Möglichkeiten der Plattform erweitern und anpassen möchten.

Erste Schritte

Bei idloom glauben wir fest an das Eigentum an Daten, die du sammelst, gehören vollständig dir. Deshalb sind unsere Integrationsmodule ab der Light-Version verfügbar, sodass du idloom nahtlos in dein Software-Ökosystem integrieren kannst, egal ob du ein regelmäßiger oder gelegentlicher Benutzer bist.

Navigiere zum Integrationsbereich der Events App und starte eine neue Integration. Du kannst aus einem vordefinierten Set nativer Integrationen wählen oder eine benutzerdefinierte Integration erstellen, die wir weiter unten genauer erklären werden.

Benutzerdefinierte Integration

Die Integration besteht aus vier zentralen Bausteinen:

1. Grundeinstellungen: Definiere den Namen, das Profil, das es verwendet, und ob es für API-Aufrufe genutzt wird, inklusive API-Schlüssel.
2. Automatische Konfiguration: Erstelle eine feste Struktur für Anmeldeformulare, um konsistente Daten an externe Apps zu senden.
3. Feldzuordnung: Passe die Daten an, um Kompatibilität mit der externen App sicherzustellen.​​​​​​​
4. Webhooks: Aktiviere Webhooks für Echtzeit-Datenübertragung und verknüpfe sie mit idloom-Triggern zur Automatisierung.

Profil-Datenzugriff Aktivieren

Mit der Integration, die du erstellst, kannst du auf Event- und Registrierungsinformationen über APIs zugreifen oder Webhooks auslösen. Dazu musst du das entsprechende Profil mit der Integration verbinden und API-Zugriff aktivieren.

Um die Datensicherheit zu erhöhen, empfehlen wir, die Datenexposition zu minimieren:

1. Erstelle separate Integrationen für verschiedene Profil-Daten.
2. Aktiviere API-Zugriff nur, wenn nötig.
3. Generiere einen neuen API-Schlüssel beim Wechsel von Entwicklung zu Produktion und rotiere ihn regelmäßig (z.B. alle 6–12 Monate).

Webhooks Erstellen und Verwalten

Beginne mit dem Hinzufügen eines Webhooks und wähle den auszulösenden Trigger:

• event.create, event.update, event.delete, event.manual: Diese Trigger senden eine REST-Event-Payload an dein Endpoint, im gleichen Format wie die API-Methode Get Events. Der manuelle Trigger fügt zudem eine neue Option in den eventbezogenen Aktionen hinzu, zugänglich über das Kontextmenü der Liste oder das Menü „Weitere Aktionen“ in den Eventdetails.
• guest.create, guest.update, guest.delete, guest.manual: Diese Trigger senden eine REST-Teilnehmer-Payload an dein Endpoint, im gleichen Format wie die API-Methode Get Attendees. Der manuelle Trigger fügt eine neue Option in den teilnehmerbezogenen Aktionen hinzu.

Als nächstes kannst du den Namen des Webhooks, die URL für den Payload-Versand und die HTTP-Methode (GET, POST, PUT, DELETE, PATCH) festlegen. Wenn du einen manuellen Trigger ausgewählt hast, wird der Webhook-Name das Label der neuen Funktion im Menü.

Du kannst auch Anfrage-Header wie Bearer Tokens oder andere Sicherheitsoptionen konfigurieren.

Wenn du den Webhook auf bestimmte Events beschränken möchtest, gib ihre UID-Werte, durch Kommas getrennt, ein. Diese Informationen findest du im Bereich Geek > Analytics & Tracking in deinen Event-Einstellungen.

Webhooks für Integrationen in deinen Profilen aktivieren

Du bist fast fertig. Während das Verbinden einer Integration mit Profilen und das Aktivieren des API-Zugriffs automatisch API-Aufrufe für alle Profile ermöglicht, gilt dies nicht für Webhooks.

Um Webhooks für eine bestimmte Integration zu aktivieren, gehe zu Events Profiles, wähle ein Profil aus und navigiere zu Geek > Integrations. Dort kannst du die gewünschte Integration aktivieren. Beachte, dass nur eine Integration pro Profil gleichzeitig aktiv sein kann.

Überschreiben der Standardintegration eines Profils für ein bestimmtes Event

Das Gute ist, dass du die für ein Profil aktivierten Webhooks für ein bestimmtes Event überschreiben kannst. Gehe einfach in den Bereich Geek > Integrations in den Event-Einstellungen, wähle die gewünschte Integration aus, passe die Feldzuordnung an oder überschreibe sie bei Bedarf, und entscheide sogar, ob Webhooks ausgelöst werden sollen, wenn eine Registrierung bezahlt wurde.

Mehr Anpassung benötigt?

Falls du zusätzliche Verarbeitung oder Validierung vor dem Versand der Payload oder eine verbesserte Sicherheit mit Two-Way SSL benötigst, wende dich an deinen Account Manager, der dein Anliegen an unser technisches Team weiterleiten wird.

Wir sind bestrebt, die bestmögliche Dokumentation zu bieten, auch bei technischen Inhalten. Wenn du Fragen oder Anregungen hast, zögere nicht, uns zu kontaktieren. Dein Feedback hilft uns, diese Anleitung und den FAQ-Bereich zu verbessern.

Enjoy!

The idloom-events team