Zum Inhalt springen
PynPyn

Webhooks

Ein eingehender Webhook ist eine Adresse, an die ein anderes System JSON postet. Jeder Webhook gehört zu einem Formular: Eine ankommende Payload wird zu einer Einsendung dieses Formulars für die Person, die die Payload nennt, und diese Einsendung kann eine Automation auslösen. Webhooks werden auf dem Formular erstellt, in seinem Seitenpanel Webhook; Settings listet sie alle an einem Ort.

The Webhooks view in Settings, listing the workspace's inbound webhooks.
Settings > General > Webhooks lists every inbound webhook created on a form.
  • Der Endpunkt ist POST /api/webhook/<webhook id> mit dem Header Authorization: Bearer <secret> und einem JSON-Body. Das Panel zeigt die URL und den Header, die zu senden sind: „Post a JSON body here, with the secret as a bearer token.“
  • Der Body nennt die Person mit subject_id und die Antworten unter fields. Die Einstellung Subject des Formulars sagt, aus welchem Quellsystem diese ID stammt, zum Beispiel eine BambooHR-Mitarbeitenden-ID.
  • Jeder Aufruf wird mit 202 beantwortet, sobald er angenommen ist; der Tab History ist die Aufzeichnung dessen, was aus jeder Payload wurde. Einträge haben einen Code wie submitted, unknown-subject, missing-fields, invalid-fields, ambiguous-fields oder already-submitted.
  • Sende einen Header Idempotency-Key, um Wiederholungen sicher zu machen: Eine Wiederholung mit demselben Schlüssel wird erneut mit 202 beantwortet, aber nicht ein zweites Mal verarbeitet.
  • Eine Payload, die Pyn nicht annehmen konnte, erzeugt eine Benachrichtigung in Notices; ein Aufrufer, der denselben Fehler wiederholt, aktualisiert eine einzige Benachrichtigung, statt viele zu erzeugen. Admins können auch per E-Mail informiert werden; siehe Benachrichtigungs-E-Mails festlegen.
  • Ein Webhook nimmt nichts an, bis er ein Secret hat, und ein archivierter Webhook nimmt keine Payloads mehr an.
  • Ein Webhook-Secret erstellen oder ersetzen
  • Einen Webhook aus seinem Panel umbenennen: Bearbeite den Title und drücke Enter oder klicke woanders hin, um zu speichern
  • Die History der Payloads lesen und das ganze Protokoll als CSV aus dem Webhook-Seitenpanel des Formulars exportieren
  • Einen Webhook aus seinem …-Menü archivieren

Öffne /settings/general/webhooks in Pyn, oder öffne Settings in der Hauptnavigation und wähle Webhooks unter General. Um einen Webhook zu erstellen, öffne das Formular in Forms, wähle Settings in der Leiste und dann Add Webhook.