コンテンツにスキップ
PynPyn

Webhookを作成する

回答の中には、すでに別のシステムにあるものがあります。LMSで修了した研修、チケットツールでの機器の申請、署名済みの書類などです。フォームのWebhookを使うと、そのシステムが回答を送信としてPynに投稿し、指定した従業員に紐づけて記録できます。

  • あなたがAdminであること。
  • フォームが作成され公開されていて、相手のシステムが対応づけられるフィールドのラベルを持っていること。フォームを作成するを参照してください。
  • 相手のシステムが、HRISの各従業員のid、つまりPynがその連携から得ているのと同じidを送れること。
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.
フォームのSettingsサイドパネル。WebhookのURL、ヘッダー、サブジェクト、本文の例があります。
  1. Pynで、左ナビゲーションのFlowsを開き、Formsを選んで、フォームを選びます。

  2. エディターの右のレールでSettingsを選びます。サイドパネルには「Add a webhook to let another system submit this form on an employee’s behalf.」とあります。Add Webhookを選びます。Webhookを追加できない場合は、Could not add this webhookというトーストが表示され、サイドパネルは元のままです。

  3. サイドパネルの上部のコールアウトには「This webhook accepts nothing until it has a secret.」とあります。Create Secretを選ぶと、コールアウトは「Copy this secret now. It is shown once and cannot be retrieved later.」に変わります。相手のシステムにコピーしてからDoneを選びます。シークレットを発行できない場合は、Could not create the secretというトーストが表示され、コールアウトは元のままです。すでにシークレットを持つWebhookでは「This webhook already has a secret. Replace it if the old one has been lost.」と表示され、代わりにReplace Secretが用意されています。下を参照してください。

  4. コールアウトの下でURLをコピーし、ヘッダーAuthorization: Bearer <secret>を控えます。

  5. Subjectの下で、相手のシステムが送るidのソースシステム(例:BambooHR Employee IDやWorkday Worker ID)を選びます。説明には「The submission is recorded against the employee holding this id.」とあります。

  6. 「Post a body of this shape.」の下の例を読みます。各フィールドをエイリアス(ラベルのキャメルケース)とサンプル値で示し、subject_idが加わります。

  7. 相手のシステムからテストのペイロードを送り、サイドパネルの下部のログ(Payloads this webhook has taken, and what became of them.)を読みます。緑のエントリーには「Recorded a submission for the … identifier …」とあり、赤のエントリーには問題の内容が示されます。

シークレットのローテーションとログの読み方

Section titled “シークレットのローテーションとログの読み方”
  • Replace Secretは1回の操作でシークレットをローテーションし、古いものはすぐに使えなくなります。確定する前に呼び出し元のシステムを更新してください。
  • ログには直近20件のエントリーが表示されます。エントリーが1件でもあれば、その横のエクスポートアイコンでログ全体をpyn-webhook-log.csv(receivedAt、outcome、action、code、message、eventId、subjectId、submissionId)としてダウンロードできます。
  • 受け付けられなかったペイロードは、通知にも通知を上げます。同じ間違いが繰り返されても、多くの通知ではなく1つの通知が最新の状態に保たれます。その行にはAcknowledge、続いてArchiveがあります。すべてのAdminにメールするかOwnerだけにするかは、ワークスペースの通知設定で決まります。

受け付けられたペイロードは、フォームのActivityサイドパネルに送信として表示され、従業員のレコードにはBuddyやMentorの値が入ります。各従業員について送信できるのはWebhookごとに一度だけで、2回目はalready-submittedとしてログに記録されます。Webhook APIに、エンドポイント、ヘッダー、本文、レスポンス、すべてのログのコードがあります。

  • Webhook API:正確なリクエストとレスポンスについてです。
  • フォームを作成する:ペイロードが埋めるフィールドについてです。
  • 通知:失敗が表示される場所です。