Webhook が送信するリクエストについて記載します。
HTTP メソッド
POST メソッドを利用して、Webhook URL に HTTP リクエストが送信されます。
リクエストヘッダー
HTTP リクエストには以下のヘッダーが設定されます。
| ヘッダー名 | 値 |
|---|---|
| Content-Type | application/json |
| User-Agent | KARTE-App-Webhook/2.0 |
| X-Karte-Signature | Unix Timestamp(単位は秒) |
| X-Karte-Request-Timestamp | HMAC-SHA256 キー付きのハッシュ |
X-Karte-Signature と X-Karte-Request-Timestamp はHMAC認証で利用します。詳細は後述の HMAC認証 を参照ください
共通リクエストボディ
{
"id": "{ユニークなID}",
"client_id":"{Client Id}",
"api_key":"{Api Key}",
"event_type":"{Event Type}",
"data": "{Object}",
"extra": "{Object}",
}
| Name | Description |
|---|---|
| id | Webhook ごとに割り振られるユニークな ID |
| client_id | アプリのClient Id |
| api_key | プロジェクトの api key |
| event_type | hook のトリガーを表す文字列 |
| data | hook する情報。各 hook 特有のデータが入ります。 |
| extra | 補足情報 |