Hilfecenter

API & Webhooks

Peerdom bietet eine REST API und ein Webhook-System fuer individuelle Integrationen. Nutzen Sie die API, um Organisationsdaten zu lesen und zu schreiben. Nutzen Sie Webhooks, um Echtzeit-Benachrichtigungen zu erhalten, wenn sich Ihre Map aendert.

REST API

Die vollstaendige API-Dokumentation finden Sie unter api.peerdom.org/v1/docs.

Authentifizierung

Jede API-Anfrage erfordert einen API Key in den Request-Headern. Jeder Key ist einer einzelnen Organisation zugeordnet.

Um einen API Key zu erstellen, navigieren Sie zu Settings > My Data > API Keys in den Organisationseinstellungen und klicken Sie auf Create a key. Nur Benutzer mit Owner-Zugriffsrechten koennen API Keys erstellen und verwalten.

API Keys gewaehren vollen Lese- und Schreibzugriff auf die Daten Ihrer Organisation. Behandeln Sie sie wie Passwoerter und teilen Sie sie niemals in oeffentlichen Repositories oder clientseitigem Code.

Anwendungsfaelle

Die API unterstuetzt eine Vielzahl von Integrationen:

  • Organisationsdaten mit Ihrem HRIS oder Ihrer People-Plattform synchronisieren
  • Roles, Circles und Peer-Daten fuer das Reporting exportieren
  • Individuelle Dashboards oder interne Tools erstellen
  • Organisationsstruktur in andere Systeme einspeisen

Webhooks

Webhooks senden HTTP-POST-Anfragen an Ihren Endpunkt, sobald bestimmte Ereignisse in Peerdom auftreten. Konfigurieren Sie Webhooks unter Settings > My Data > Webhooks in den Organisationseinstellungen.

Verfuegbare Ereignisse

  • Role: Create, Update, Delete
  • Group: Create, Update, Delete
  • Peer: Create, Update, Delete

Endpunkt testen

Verwenden Sie die Funktion Test URL im Webhook-Konfigurationspanel, um Ihren Endpunkt vor dem Speichern zu validieren. Dies sendet eine Beispiel-Payload, damit Sie bestaetigen koennen, dass Ihr Server die Anfrage korrekt verarbeitet.

Richten Sie Webhooks ein, um Zapier-Zaps oder n8n-Workflows in Echtzeit auszuloesen, anstatt die API periodisch abzufragen.

Automatisierungsplattformen

Mehrere No-Code- und Low-Code-Plattformen funktionieren hervorragend mit der Peerdom API:

  • Zapier: Verbinden Sie Peerdom mit ueber 7’000 Apps mittels eines visuellen Workflow-Builders. Siehe die Zapier-Integrationsanleitung.
  • Pipedream: Entwicklerfreundliche Plattform mit HTTP-Triggern, individuellen Code-Steps (JavaScript und Python) und einem grosszuegigen kostenlosen Plan.
  • n8n: Open-Source- und selbst hostbare Workflow-Automatisierung mit HTTP-Request-Nodes und ueber 400 integrierten Integrationen.

Alle drei Plattformen koennen Peerdom-Webhooks konsumieren und die REST API aufrufen, um bidirektionale Workflows zu erstellen.

Verwandte Artikel