ドキュメント

エンドポイントの追加と設定(署名シークレット・対象イベント・再送信ポリシー)

必要な権限とプラン

閲覧
Viewer 以上
追加・変更・削除・署名シークレットの表示
Developer 以上
プラン
Webhook(HTTPS)はすべてのプラン。ポーリングと固定送信元 IP は Starter 以上、Webhook 以外の種類は Pro 以上

エンドポイントを追加する

  1. メニューの「エンドポイント」を開き、「+ エンドポイントを追加」を押します。
  2. 「顧客アカウント」を選びます(先に顧客アカウントの登録が必要です)。
  3. 「エンドポイントの種類」を選びます(既定は Webhook(HTTPS))。
  4. 「エンドポイント URL」に https で始まる URL を入力します。テスト環境では http も使用できます。
  5. 「対象イベント」で「すべて」または「選択」を選びます。「選択」の場合は、登録済みのイベントタイプから 1 つ以上選びます。
  6. 必要に応じて「固定送信元 IP から配信」をオンにし、「詳細設定(ペイロード形式・再送信・メモ)」を開いて設定します。
  7. 「追加」を押します。表示された署名シークレット(whsec_…)をコピーし、受信側に設定します。

署名の検証方法は署名検証をご覧ください。署名シークレットは、後からエンドポイントの「設定」タブの「表示」でも確認できます。

エンドポイントの種類

種類内容プラン
Webhook(HTTPS)指定した URL へ POST で配信します。すべて
ポーリング受信側がトークンを使って取得します。外部からアクセスできない環境でも受信できます。Starter 以上
Amazon SQS・EventBridge・S3、Google Cloud Pub/Sub・Storage、Cloudflare R2、Azure Blob Storage・Service Bus、Kafka(Confluent Cloud)、RabbitMQ(HTTP API)各サービスの認証情報を入力して配信します。「接続テスト」で事前に確認できます。Pro 以上
Slack・Microsoft Teams・Chatworkチャットに投稿します。メッセージはペイロードの text・title・lines・link から組み立てます。署名は付与しません。Pro 以上

ポーリングエンドポイントのトークンを作成する

  1. 種類に「ポーリング」を選んで追加すると、エンドポイントの詳細が開きます。
  2. 「設定」タブの「ポーリング URL」を確認し、「トークンを作成」を押します。
  3. 「名前」(例: 本番の受信サーバー)を入力して作成します。
  4. 表示されたトークンをコピーし、受信側に設定します。トークンはこの画面でのみ表示されます。

トークンはエンドポイントごとに 5 つまで作成できます。「最終ポーリング」で、受信側が最後に取得した日時を確認できます。

「設定」タブで変更できる項目

項目内容
対象イベント「変更」を押すと「対象イベント」タブで変更できます。
署名シークレット「表示」で確認できます。「シークレットを再発行」を押すと新しいシークレットを発行し、古いシークレットによる署名も 24 時間は併せて付与します。
固定送信元 IPオンにすると 209.71.107.233 から配信します(固定送信元 IP)。
配信順序オンにすると順序保証(FIFO)になり、前のメッセージの配信が完了するまで次の配信を待機します。
再送信再送信回数(再送信しない・1・2・3・5・7・12 回)と再送信間隔(段階的に延長・1 分・5 分・30 分・1 時間・6 時間ごと)を選びます。既定は初回を含めて最大 8 回、約 28 時間です。
互換署名独自の署名検証を実装している受信側のために、HMAC-SHA256 の署名ヘッダーを 1 つ追加します。Standard Webhooks のヘッダーは常に付与します。
トランスフォーメーショントランスフォーメーションの設定です(Pro 以上)。
ペイロード形式標準(type・timestamp・data でラップ)か、data のみかを選びます。
アラートこのエンドポイントが対象になる通知チャネルを表示します。

「変更履歴」タブで、このエンドポイントの設定の変更履歴を確認できます。

テスト送信・一時停止・削除

  • 「テスト送信」: このエンドポイントだけにテストのメッセージを送信します。テスト送信は月間上限の対象外です。
  • 「一時停止」: 配信を止めます。一時停止中に受け付けたメッセージは保留し、「再開」を押すと配信します(ポーリングエンドポイントでは、一時停止中に受け付けたメッセージは取得できません)。
  • 削除: 「設定」タブの最下部の「削除」を押します。再送信待ちのメッセージは配信されなくなります。この操作は取り消せません。

自動で無効化された場合

配信の失敗が 5 日間続くと、エンドポイントを自動で無効化し、詳細画面に理由を表示します。受信側を修正してから「再開」を押すと、配信を再開します。無効化されていた間のメッセージは、このエンドポイントには配信されません。

プランの変更で固定送信元 IP・トランスフォーメーション・Webhook 以外の種類が使えなくなった場合は、エンドポイントを一時停止して配信を保留します。必要なプランに変更してから「再開」を押すと、保留中のメッセージを配信します。