Helpcentrum

API en Webhooks

Peerdom biedt een REST API en webhooksysteem voor het bouwen van eigen integraties. Gebruik de API om organisatiegegevens te lezen en te schrijven. Gebruik webhooks om realtime meldingen te ontvangen wanneer je kaart verandert.

REST API

Volledige API-documentatie is beschikbaar op api.peerdom.org/v1/docs.

Authenticatie

Elk API-verzoek vereist een API-sleutel in de request-headers. Elke sleutel werkt binnen de context van een enkele organisatie.

Om een API-sleutel aan te maken, ga je naar Instellingen > Mijn gegevens > API-sleutels in Organisatie-instellingen en klik je op Sleutel aanmaken. Alleen gebruikers met Eigenaar/es-toegangsrechten kunnen API-sleutels aanmaken en beheren.

API-sleutels geven volledige lees- en schrijftoegang tot de gegevens van je organisatie. Behandel ze als wachtwoorden en deel ze nooit in openbare repositories of client-side code.

Toepassingen

De API ondersteunt een breed scala aan integraties:

  • Organisatiegegevens synchroniseren met je HRIS of personeelsplatform
  • Rollen, cirkels en collega-gegevens exporteren voor rapportages
  • Eigen dashboards of interne tools bouwen
  • Organisatiestructuur doorvoeren naar andere systemen

Webhooks

Webhooks sturen HTTP POST-verzoeken naar je endpoint wanneer er specifieke gebeurtenissen plaatsvinden in Peerdom. Configureer webhooks in Instellingen > Mijn gegevens > Webhooks binnen Organisatie-instellingen.

Beschikbare gebeurtenissen

  • Rol: Aanmaken, Bijwerken, Verwijderen
  • Groep: Aanmaken, Bijwerken, Verwijderen
  • Collega: Aanmaken, Bijwerken, Verwijderen

Je endpoint testen

Gebruik de Test URL-functie in het webhookconfiguratiepaneel om je endpoint te valideren voordat je opslaat. Dit stuurt een voorbeeldpayload zodat je kunt bevestigen dat je server het verzoek correct afhandelt.

Stel webhooks in om Zapier-Zaps of n8n-workflows in realtime te triggeren, in plaats van de API op een schema te pollen.

Automatiseringsplatforms

Verschillende no-code- en low-code-platforms werken goed samen met de Peerdom API:

  • Zapier: Verbind Peerdom met meer dan 7.000 apps met een visuele workflowbuilder. Zie de Zapier-integratiehandleiding.
  • Pipedream: Ontwikkelaarsvriendelijk platform met HTTP-triggers, aangepaste codestappen (JavaScript en Python) en een ruime gratis laag.
  • n8n: Open-source en zelf te hosten workflowautomatisering met HTTP Request-nodes en meer dan 400 ingebouwde integraties.

Alle drie de platforms kunnen Peerdom-webhooks ontvangen en de REST API aanroepen om bidirectionele workflows te creëren.

Gerelateerd