メッセージの送信や顧客のタグ付け(またはタグ解除)に加え、Seriesのwebhookで他のアプリやシステムのアクションやworkflowsをオーケストレーションできます。
Seriesのwebhookを使えば、Intercomの任意のイベントやフィルターセットを利用して、以下のようなことができます:
複数のシステム間で顧客データを同期させる。
usersがSeriesでマイルストーンに達したときに、チームに内部通知を送る。
独自のカスタムアプリやデータベースで更新を行う。
webhookとは何ですか?
webhookは、usersが指定した条件(例えばイベント完了)に合致したときにIntercomから送信されるメッセージです。メッセージ(“ペイロード”)があり、指定したユニークなURLに送られます。
例えば、usersが特定のアクションを取った後にwebhookを送信するシンプルなseriesは次の通りです:
webhookにはusersの名前、会社名、IDが含まれます。webhookのペイロードは次のようになります:
POST https://examply.io/webhooks
Content-Type: application/json
{
name: “Lonnie Lynn”
company: “CSense Ltd”
company_id: “c0m5en5e”
}
webhookを受け取るアプリケーションは、そのペイロードのデータで何か(または多くのこと)を行うことができます。👌
注意:Seriesでのwebhook送信は特定のIntercomプランでのみ利用可能です。プランと料金はこちら。
seriesにwebhookを追加する方法
右側のメニューからwebhookをドラッグし、トリガーしたい任意のルールブロックの後にseriesに接続します:
webhookブロックを開いてタイトルを付けます:
送信するデータと送信先を正確に設定できます。
プロのヒント:別のアプリ(例えばZapier)にwebhookを送る場合、通常はドキュメントでリクエストの種類、webhook URL、必要なヘッダーを確認できます。 独自のアプリにwebhookを送る場合は、エンジニアがこの情報を提供できるはずです。👌 |
まずはHTTPメソッドとwebhook URLから始めましょう:
メソッドはPUTかPOSTを選択でき、URLはwebhookを受け取るアプリのものです。
ヒント:テスト時にはRequestBinなどのサービスを使えます。
次に、webhookヘッダーをキーと値のペアで追加します:
webhookを送信するにはContent-Typeヘッダーのみが必須(JSONまたはURLエンコード)ですが、webhookを受信するには追加のヘッダーが必要な場合があります。
例えば、受信アプリで認証が必要な場合があります。
新しいヘッダーを追加するには、「+ キーと値のペアを追加」をクリックします:
オプションで、webhook本文に含めるデータをキーと値のペアで選択します。この例では名前、会社名、会社IDを送信しています。
動的データには「{...}」メニューからIntercom属性を追加します:
webhookのテスト
seriesを公開する前に、webhookが正しく送信・受信されるかテストすることを推奨します。「テスト」をクリック:
テストusersの名前またはメールアドレスを入力すると、webhookのペイロードにデータが反映されます:
次に選択して「テスト実行」をクリック:
受信アプリからのレスポンスが表示されます:
注意:“200”の成功コードが表示されるはずです。その他のコードは受信アプリでトラブルシューティングが必要かもしれません。
webhookが失敗したらどうなりますか?
webhookが成功すると「送信済み」統計を記録します。失敗するとさらに2回送信を試みます。3回目の再試行後、チェックポイントは「失敗」とマークされます。seriesが公開されたらwebhookをクリックして結果を確認できます。👍
