Webhook の概要
案件や予定が変わったときに、設定した URL へデータを送る仕組みです。
Webhook を設定すると、案件や予定が変わったときや、書類作成の画面で送信を選んだときに、そのときのデータを JSON で、設定した URL へ POST で送ります。受け取ったデータの使い道は、受信する側で決めます。
Webhook はビジネスプランとカスタムプランで使えます。
設定する
設定の画面の外部連携で、代表者と管理者が設定します。
| 項目 | 内容 |
|---|---|
| Webhook URL | 送信先の URL です。空欄で保存すると、送信を止めます |
| シークレットキー | 送信データの署名に使う値です。受信する側で、CrewGear からの送信であることを確かめるのに使います |
| 送信するイベント | 案件の作成、案件の更新、案件のキャンセル、書類作成からの送信、予定の作成、予定の更新、予定の削除から選びます |
シークレットキーを再発行すると、受信する側でも新しいキーへの切り替えが必要です。
送信のリクエスト
POST <Webhook URL>?webhook_t=<t>&webhook_sig=<sig>
Content-Type: application/json
User-Agent: CrewGear-Webhook/1
X-Webhook-Signature: t=<t>,v1=<sig>
<送信データ>- 送信は CrewGear のサーバーから行います。ブラウザからは送りません。
- 署名の
<t>と<sig>は、ヘッダーとクエリの両方に同じ値を載せます。Webhook URL にすでにクエリがあるときは&でつなぎます。署名の作り方は署名をご覧ください。 - 送信データの形は送信データをご覧ください。
送信先の条件
- Webhook URL は
httpsだけを受け付けます。 - 送信のときに送信先のアドレスを確かめ、社内ネットワークやループバックなど、インターネットに公開されていないアドレスへは送りません。
- リダイレクトは追いません。
送らないもの
- 受信した側の処理の内容や結果は扱いません。応答の本文も読みません。
- シークレットキーそのものは送りません。