Zum Inhalt springen
PynPyn

Einen Webhook erstellen

Manche Antworten existieren schon in einem anderen System: eine abgeschlossene Schulung in deinem LMS, eine Geräteanfrage in einem Ticket-Tool, ein unterschriebenes Dokument. Ein Webhook an einem Formular lässt dieses System die Antwort als Einsendung in Pyn posten, erfasst für die Person, die es nennt.

  • Du bist Admin.
  • Das Formular ist gebaut und veröffentlicht, mit Feldbeschriftungen, die dein anderes System zuordnen kann. Siehe Ein Formular erstellen.
  • Das andere System kann die ID jeder Person aus deinem HRIS senden, dieselbe ID, die Pyn aus dieser Integration hat.
The Settings drawer on a form with a webhook: the secret callout with Replace Secret, the Subject select set to Employee File ID, the example body and the log listing the recorded submissions and the rejected payload.
Das Seitenpanel Settings eines Formulars, mit URL, Header, Subject und Beispiel-Body des Webhooks.
  1. Öffne in Pyn Flows in der linken Navigation, wähle Forms und dann das Formular.

  2. Wähle Settings in der Leiste rechts im Editor. Das Seitenpanel zeigt Add a webhook to let another system submit this form on an employee’s behalf. Wähle Add Webhook. Lässt sich der Webhook nicht hinzufügen, zeigt ein Toast Could not add this webhook und das Seitenpanel bleibt, wie es war.

  3. Oben im Seitenpanel zeigt der Hinweis This webhook accepts nothing until it has a secret. Wähle Create Secret; der Hinweis zeigt dann Copy this secret now. It is shown once and cannot be retrieved later. Kopiere es in das andere System und wähle dann Done. Lässt sich das Secret nicht erzeugen, zeigt ein Toast Could not create the secret und der Hinweis bleibt, wie er war. Ein Webhook, der schon ein Secret hat, zeigt This webhook already has a secret. Replace it if the old one has been lost. und bietet stattdessen Replace Secret; siehe unten.

  4. Kopiere unter dem Hinweis die URL und merke dir den Header: Authorization: Bearer <secret>.

  5. Wähle unter Subject das Quellsystem, dessen ID das andere System senden wird, zum Beispiel BambooHR Employee ID oder Workday Worker ID. Die Beschreibung lautet The submission is recorded against the employee holding this id.

  6. Lies das Beispiel unter Post a body of this shape. Es nennt jedes Feld über seinen Alias (die Beschriftung in camelCase) mit einem Beispielwert, plus subject_id.

  7. Sende aus dem anderen System eine Test-Payload und lies das Protokoll am Fuß des Seitenpanels (Payloads this webhook has taken, and what became of them.). Ein grüner Eintrag zeigt Recorded a submission for the … identifier …; ein roter nennt das Problem.

  • Replace Secret rotiert das Secret in einem Schritt, und das alte hört sofort auf zu funktionieren; aktualisiere das aufrufende System, bevor du bestätigst.
  • Das Protokoll zeigt die 20 neuesten Einträge. Sobald es einen Eintrag gibt, lädt ein Export-Symbol daneben das ganze Protokoll als pyn-webhook-log.csv herunter (receivedAt, outcome, action, code, message, eventId, subjectId, submissionId).
  • Eine verworfene Payload löst zusätzlich eine Benachrichtigung in Notices aus, und derselbe wiederholte Fehler hält eine Benachrichtigung aktuell statt viele; ihre Zeile bietet Acknowledge, dann Archive. Die Benachrichtigungseinstellungen des Workspace entscheiden, ob jeder Admin eine E-Mail bekommt oder nur der Owner.

Angenommene Payloads erscheinen als Einsendungen im Seitenpanel Activity des Formulars, und der Datensatz der Person enthält jeden Buddy- oder Mentor-Wert. Für jede Person ist pro Webhook eine Einsendung möglich; eine Wiederholung wird als already-submitted protokolliert. Webhook-API listet Endpunkt, Header, Body, Antworten und jeden Protokollcode.