Ga naar inhoud
PynPyn

Webhooks

Een inkomende webhook is een adres waar een ander systeem JSON naartoe post. Elke webhook hoort bij een formulier: een payload die binnenkomt wordt een inzending van dat formulier voor de medewerker die in de payload wordt genoemd, en die inzending kan een automation starten. Webhooks worden op het formulier gemaakt, in zijn zijpaneel Webhook; Settings toont ze allemaal op één plek.

The Webhooks view in Settings, listing the workspace's inbound webhooks.
Settings > General > Webhooks lists every inbound webhook created on a form.
  • Het endpoint is POST /api/webhook/<webhook id> met de header Authorization: Bearer <secret> en een JSON-body. Het paneel toont de URL en Header om mee te sturen: “Post a JSON body here, with the secret as a bearer token.”
  • De body vermeldt de medewerker met subject_id en de antwoorden onder fields. De instelling Subject van het formulier zegt uit welk bronsysteem dat id komt, bijvoorbeeld een BambooHR-medewerkers-id.
  • Elke aanroep krijgt 202 als antwoord zodra hij is geaccepteerd; het tabblad History is het verslag van wat er met elke payload is gebeurd. Items hebben een code zoals submitted, unknown-subject, missing-fields, invalid-fields, ambiguous-fields of already-submitted.
  • Stuur een header Idempotency-Key mee om herhalingen veilig te maken: een herhaling van dezelfde sleutel krijgt opnieuw 202 als antwoord maar wordt niet een tweede keer verwerkt.
  • Een payload die Pyn niet kon aannemen maakt een melding aan in Notices; een aanroeper die één fout herhaalt werkt één melding bij in plaats van er veel aan te maken. Admins kunnen er ook over worden gemaild; zie E-mails over meldingen instellen.
  • Een webhook neemt niets aan totdat hij een secret heeft, en een gearchiveerde webhook neemt geen payloads meer aan.
  • Een webhook-secret maken of vervangen
  • Een webhook hernoemen vanuit zijn paneel: bewerk de Title en druk op Enter, of klik ergens anders, om op te slaan
  • De History van payloads lezen en het hele log als CSV exporteren vanuit het zijpaneel Webhook van het formulier
  • Een webhook archiveren vanuit zijn menu …

Open /settings/general/webhooks in Pyn, of open Settings in de primaire navigatie en selecteer Webhooks onder General. Wil je een webhook maken, open dan het formulier in Forms, selecteer Settings in de balk en dan Add Webhook.