第13章 Webhook

本章では、デベロッパーポータル で Webhook を設定し、操作を行う方法について説明します。

Webhook を使用すると、3scale をバックオフィスのワークフローと密接に統合できます。3scale システムで指定のイベントが発生すると、Webhook メッセージによりアプリケーションに通知が届き、新規アカウントのサインアップからのデータなどを使用して、CRM システムに反映させることができます。

13.1. Webhook の概要

Webhook は、イベントによってトリガーされるカスタムの HTTP コールバックです。3scale システムでは、考え得るすべてのイベントが Account Settings (右上隅の歯車アイコン) の Integrate > Webhooks に表示されます。

Howtos Webhooks Overview

これらのイベントのいずれかが発生すると、3scale システムは、Webhook セクションに設定された URI に対して HTTP (または HTTPS) リクエストを行います。API プロバイダー側では、リスナーを設定してイベント追跡などの目的の動作を呼び出すことができます。

スクリーンショットの 2 つのチェックボックスは、Webhook を有効にするためのものと (Webhooks are スイッチ)、管理ポータルのアクションでも Webhook がトリガーされるかどうかの設定です。デフォルトの動作では、デベロッパーポータル内のアクションでしか Webhook はトリガーされません。つまり、すべてのイベントでトリガーされるわけではないことを念頭に置いておいてください。