コンテンツにスキップ
PynPyn

Webhookシークレットを作成または置き換える

Webhookはフォームで作成しますが、シークレットを持つまで何も受け付けません。Webhookのパネルからシークレットを発行し、呼び出し側のシステムにコピーし、漏えいしたり相手のシステムが紛失したりしたら置き換えます。シークレットは一度だけ表示され、あとから読み返すことはできません。

  • あなたが管理者またはオーナーであること。
  • Webhookが存在すること。なければ、フォームでフォームを開き、レールのSettingsを選んでからAdd Webhookを選びます。
  • 呼び出し側のシステムの資格情報ストアなど、シークレットを安全に貼り付けられる場所があること。
The Webhooks view in Settings, listing the workspace's inbound webhooks.
Settings > General > Webhooks lists every inbound webhook created on a form.
  1. Pynで左のナビゲーションのSettingsを開き、Generalの下のWebhooksを開きます。

  2. Webhookを選びます。パネルが開きます。シークレットがなければ「This webhook accepts nothing until it has a secret.」と表示されます。

  3. Create Secretを選びます。パネルにシークレットが「Copy this secret now. It is shown once and cannot be retrieved later.」とともに表示されます。シークレットを発行できない場合は、Could not create the secretというトーストが表示され、パネルは元のままです。

  4. コピーして呼び出し側のシステムに保存し、Doneを選びます。

  5. 「Post a JSON body here, with the secret as a bearer token.」の下に表示されるURLをコピーし、呼び出し側がAuthorization: Bearer <secret>とJSONのボディを送るように設定します。

  6. あとでローテーションするには、Replace Secretを選びます。確認には「The current secret stops working immediately. Anything calling this webhook will need the new one.」という警告が表示されます。Replaceを選び、新しい値をコピーします。シークレットを置き換えられない場合は、Could not replace the secretというトーストが表示され、古いシークレットは引き続き使えます。

シークレットがある状態では、パネルに「This webhook already has a secret. Replace it if the old one has been lost.」と表示されます。相手のシステムからテストのペイロードを送ってください。Historyタブに数秒以内にその結果とともに表示されます。送信になったペイロードにはsubmitted、そうでなければunknown-subjectなどの理由コードです。間違ったシークレットやシークレットなしで送られたペイロードには404が返り、ログには現れません。

  • Webhook:ペイロードの形と結果のコードについてです。
  • フォーム:Webhookを作成してサブジェクトを設定するにはこちらです。