Ga naar inhoud
PynPyn

Een webhook maken

Sommige antwoorden bestaan al in een ander systeem: een afgeronde training in je LMS, een apparatuuraanvraag in een ticketingtool, een ondertekend document. Met een webhook op een formulier kan dat systeem het antwoord als inzending in Pyn posten, vastgelegd bij de medewerker die het noemt.

  • Je bent een Admin.
  • Het formulier is gebouwd en gepubliceerd, met veldlabels waar je andere systeem op kan mappen. Zie Een formulier bouwen.
  • Het andere systeem kan van elke medewerker het id uit je HRIS meesturen, hetzelfde id dat Pyn uit die integratie heeft.
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.
Het Settings-zijpaneel op een formulier, met de URL, header, subject en voorbeeldbody van de webhook.
  1. Open in Pyn Flows in de linkernavigatie, selecteer Forms en dan het formulier.

  2. Selecteer Settings in de balk rechts van de editor. Het zijpaneel toont Add a webhook to let another system submit this form on an employee’s behalf. Selecteer Add Webhook. Kan de webhook niet worden toegevoegd, dan meldt een toast Could not add this webhook en blijft het zijpaneel zoals het was.

  3. Bovenaan het zijpaneel toont de melding This webhook accepts nothing until it has a secret. Selecteer Create Secret; de melding toont dan Copy this secret now. It is shown once and cannot be retrieved later. Kopieer het naar het andere systeem en selecteer dan Done. Kan het secret niet worden aangemaakt, dan meldt een toast Could not create the secret en blijft de melding zoals ze was. Een webhook die al een secret heeft toont This webhook already has a secret. Replace it if the old one has been lost. en biedt in plaats daarvan Replace Secret; zie hieronder.

  4. Kopieer onder de melding de URL en noteer de header: Authorization: Bearer <secret>.

  5. Selecteer onder Subject het bronsysteem waarvan het andere systeem het id gaat meesturen, bijvoorbeeld BambooHR Employee ID of Workday Worker ID. De beschrijving toont The submission is recorded against the employee holding this id.

  6. Lees het voorbeeld onder Post a body of this shape. Het noemt elk veld bij zijn alias (het label in camelCase) met een voorbeeldwaarde, plus subject_id.

  7. Stuur een testpayload vanuit het andere systeem en lees het log onderaan het zijpaneel (Payloads this webhook has taken, and what became of them.). Een groene regel toont Recorded a submission for the … identifier …; een rode noemt het probleem.

  • Replace Secret roteert het secret in één stap en het oude werkt meteen niet meer; werk het aanroepende systeem bij voordat je bevestigt.
  • Het log toont de 20 meest recente regels. Zodra er een regel is, downloadt een exportpictogram ernaast het hele log als pyn-webhook-log.csv (receivedAt, outcome, action, code, message, eventId, subjectId, submissionId).
  • Een afgewezen payload geeft ook een notice in Notices, en dezelfde herhaalde fout houdt één notice actueel in plaats van vele; de rij biedt Acknowledge en dan Archive. De notificatie-instellingen van de workspace bepalen of elke admin wordt gemaild of alleen de owner.

Geaccepteerde payloads verschijnen als inzendingen in het Activity-zijpaneel van het formulier, en het record van de medewerker bevat een eventuele Buddy- of Mentor-waarde. Per webhook kan voor elke medewerker één keer worden ingediend; een herhaling wordt gelogd als already-submitted. Webhook-API somt het endpoint, de headers, de body, de antwoorden en elke logcode op.