Custom API連携

Webhook通知機能を使ったCustom API連携では、
APIの更新時に任意のAPIへ通知を送ることができます。

Cloud FunctionsやAWS Lambda、Vercelなどで作成したAPIを呼び出したり、
ZapierやIFTTTのWebhookURLを呼び出すことで、
他の外部サービスと連携することができます。

設定方法

APIの詳細画面からWebhook機能を有効にします。

Custom APIを選択するとダイアログが表示されるので、
対象URLやHeader情報を入力します。

これで、Custom API連携の設定は完了です。

APIを更新すると連携したCustom APIが呼び出されることを確認してください。

Webhookの仕様

Custom API連携では、設定したURLにPOSTで送信します。
Headerが設定されている場合、リクエストヘッダーに含めて呼び出します。

対象のAPI IDやステータスなどは、以下のJSON形式でリクエストボディに渡されます。

{
 "api_id": "<API_ID>",
 "api_name": "<API_NAME>",
 "status": "<BUILD_STATUS>",
 "message": "<MESSAGE>",
 "timestamp": "2022-05-01T15:00:00.000Z"
}

• Webhook通知機能