Hilfecenter

API & Webhooks

Peerdom bietet eine REST API und ein Webhook-System für individuelle Integrationen. Nutze die API, um Organisationsdaten zu lesen und zu schreiben. Nutze Webhooks, um Echtzeit-Benachrichtigungen zu erhalten, wenn sich deine Karte ändert.

REST API

Die vollständige API-Dokumentation finde 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, navigiere zu Settings > My Data > API Keys in den Organisationseinstellungen und klicke auf Create a key. Nur Benutzer mit Owner-Zugriffsrechten können API Keys erstellen und verwalten.

API Keys gewähren vollen Lese- und Schreibzugriff auf die Daten deiner Organisation. Behandle sie wie Passwörter und teile sie niemals in öffentlichen Repositories oder clientseitigem Code.

Anwendungsfälle

Die API unterstützt eine Vielzahl von Integrationen:

  • Organisationsdaten mit deinem HRIS oder deiner People-Plattform synchronisieren
  • Roles, Circles und Peer-Daten für das Reporting exportieren
  • Individuelle Dashboards oder interne Tools erstellen
  • Organisationsstruktur in andere Systeme einspeisen

Webhooks

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

Verfügbare Ereignisse

  • Role: Create, Update, Delete
  • Group: Create, Update, Delete
  • Kolleg/in: Create, Update, Delete

Endpunkt testen

Verwende die Funktion Test URL im Webhook-Konfigurationspanel, um deinen Endpunkt vor dem Speichern zu validieren. Dies sendet eine Beispiel-Payload, damit du bestätigen kannst, dass dein Server die Anfrage korrekt verarbeitet.

Richte Webhooks ein, um Zapier-Zaps oder n8n-Workflows in Echtzeit auszulösen, anstatt die API periodisch abzufragen.

Automatisierungsplattformen

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

  • Zapier: Verbinde Peerdom mit über 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 grosszügigen kostenlosen Plan.
  • n8n: Open-Source- und selbst hostbare Workflow-Automatisierung mit HTTP-Request-Nodes und über 400 integrierten Integrationen.

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

Verwandte Artikel