コンテンツにスキップ
PynPyn

Webhook

インバウンドのWebhookは、別のシステムがJSONをPOSTするアドレスです。各Webhookはフォームに属します。届いたペイロードは、ペイロードが指定する従業員によるそのフォームの送信になり、その送信がオートメーションをトリガーできます。WebhookはフォームのWebhookサイドパネルで作成し、Settingsにはそれらすべてが1か所に一覧表示されます。

The Webhooks view in Settings, listing the workspace's inbound webhooks.
Settings > General > Webhooks lists every inbound webhook created on a form.
  • エンドポイントはPOST /api/webhook/<webhook id>で、ヘッダーAuthorization: Bearer <secret>とJSONのボディを付けます。パネルには送るべきURLとHeaderが表示されます。「Post a JSON body here, with the secret as a bearer token.」とあります。
  • ボディはsubject_idで従業員を、fieldsの下で回答を指定します。そのidがどのソースシステムのものか、たとえばBambooHRの従業員idかは、フォームのSubject設定が決めます。
  • すべての呼び出しには、受け付けられた時点で202が返ります。各ペイロードがどうなったかの記録はHistoryタブです。エントリにはsubmitted、unknown-subject、missing-fields、invalid-fields、ambiguous-fields、already-submittedなどのコードが付きます。
  • Idempotency-Keyヘッダーを送ると、再試行が安全になります。同じキーの繰り返しには再び202が返りますが、2回目は処理されません。
  • Pynが受け取れなかったペイロードは、通知に通知を上げます。呼び出し側が同じ間違いを繰り返しても、多数の通知が上がるのではなく1つの通知が更新されます。管理者にメールすることもできます。通知メールを設定するを参照してください。
  • Webhookはシークレットを持つまで何も受け付けず、アーカイブされたWebhookはペイロードを受け付けなくなります。
  • Webhookシークレットを作成または置き換える
  • パネルからWebhookの名前を変更する:Titleを編集し、Enterを押すか、別の場所をクリックして保存する
  • ペイロードのHistoryを読み、フォームのWebhookサイドパネルからログ全体をCSVでエクスポートする
  • メニュー(…)からWebhookをアーカイブする

Pynで/settings/general/webhooksを開くか、メインナビゲーションのSettingsを開いてGeneralの下のWebhooksを選びます。Webhookを作成するには、フォームでフォームを開き、レールのSettingsを選んでからAdd Webhookを選びます。