Webhookについて

Webhookを使用することで、DK-CONNECT BMで特定のイベントが発生する度に、外部システムへ通知を送信することができます。Web APIをポーリングする必要が無くなり、リソースを節約することができます。

Webhookはシステム管理者のみが最大10個まで作成できます。

Webhookのイベントとペイロードについて

説明

イベントの種類

説明

サイズ上限

説明

ヘッダ

説明

Webhook配信の例

説明

POST: /payload HTTP/1.2
X-Dkcbm-Hook-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958
...

Webhookを作成する

説明

Webhookの作成

説明

作成したWebhookのテスト

説明

Webhookの実行履歴の確認

説明

配信を処理する

説明

Webhookの配信を処理するコードを記述

JavaScriptの例

const express = require('express');
const app = express();
app.post('/webhook', express.json({type: 'application/json'}), (request, response) => {
　// ...
}

配信を検証する

説明

シークレットの作成

説明

配信の検証（HMAC検証）

説明

Webhookの設定

説明

Webhookを編集する

説明

Webhookを無効にする

説明

失敗した配信の処理

Webhookの配信はサーバーダウン、応答のタイムアウトなどの理由で失敗する可能性があります。
自動で再配信しませんが、手動で再配信することができます。

手動で再配信する

説明