Webhook APIを設定する
kickflowを外部のアプリケーションと連携させたいお客様向けに、Webhook APIを提供しております。Webhook APIでは、kickflow内でイベントが発生したとき（例: チケットが承認された）、イベントの内容を外部のアプリケーションに通知することができます。
Webhookを設定するには
-
「管理センター」＞「外部連携」＞「Webhook」 を開きます。
-
「新規作成」 をクリックします。
-
Webhook名 及び リクエスト先のURL と シークレット（任意） を入力します。
・シークレットは、改ざん防止のシグネチャの生成に使用されるキーです。詳しくは 開発者向けドキュメント をご確認ください。
-
任意で、送信対象と送信するイベントを選択します。デフォルトでは、すべてのワークフローのすべてのイベントが送信されます。
-
「作成」 をクリックします。
-
リクエスト先のアプリケーションにて、イベントが正しく通知されているかご確認ください。
Webhookの実行結果を確認するには
Webhookのイベント毎の実行結果は、以下方法にて確認することができます。
- 「管理センター」＞「外部連携」＞「Webhook」 を開きます。
- 対象のWebhook名の右側にある「実行結果を確認」をクリック
- 確認したいイベントの「操作」より「リクエスト結果」をクリック
確認できる内容
- リクエストID：リクエストを識別するためのID
- ステータスコード：HTTPレスポンスステータスコードが表示
- レスポンスボディ：レスポンス結果を確認
- 作成日時：リクエストが実施された日時
リクエストの仕様
リクエストの詳細な仕様については、 開発者向けドキュメント をご確認ください。
注意事項
Webhookの設定は 外部サービス連携の管理権限を持つユーザーのみ 可能です。Webhookを設定することで、kickflowにおけるチケットの閲覧制限に関わらずに企業内のすべてのチケットのイベントを外部のアプリケーションで受け取ることができるようになるため、権限管理にはご注意ください。
Webhookに登録できるURLは、インターネット経由でアクセス可能である必要があります。また、SSLを使用する場合には正規のSSLサーバー証明書を使用してください。自己署名証明書を使ったURLにはリクエストできません。登録されたURLへのリクエストが1週間失敗し続けると、kickflowは自動的にWebhookを無効化します。