SMS/EmailサービスのWebhook機能の紹介

はじめに

TOAST SMSとEmailサービスでは、広告メールの受信拒否が設定できるWebhook登録機能を提供しています。
一般的にWebhookとは「ユーザーが定義したHTTPコールバック」のことです。具体的には、特定のイベントが発生した際、事前に登録しておいたコールバックURLを自動的に呼び出すサービス間の連携方式を意味します。

TOAST Notificationでは、広告メール受信拒否の登録イベントが重要であると判断し、まずこのイベントが発生したときにWebhookを送信して、ユーザーに通知できる機能を用意しています。

Webhook登録方法

TOASTコンソールから、SMSサービスの「Webhooks管理」メニューにアクセスします。


「イベントタイプ」フィールドを選択します。SMSでは「広告メール受信拒否番号登録」、Emailでは「広告メール受信拒否アドレス登録」を選べるようになっています。(今後、イベントタイプは増える予定です)

「ターゲットURL」フィールドに、ユーザーが別途用意したウェブサービスのPOST URLを入力します。

「署名」フィールドには部外者が推測しにくい文字列を入力します。Webhookが送信される際に「署名」に登録した文字列の値がヘッダに渡されます。あらかじめ登録しておいた署名文字列と一致するかを確認し、部外者の不正使用を防止することができます。

「追加」ボタンをクリックして登録します。

Webhookメッセージの詳しいAPIガイドは、ドキュメントをご参照ください。
https://docs.toast.com/ja/Notification/SMS/ja/api-guide/

複数イベントの送信

内部的には定期的にイベントを収集してWebhookを送信するため、1つのWebhookに複数のイベントを含めて送信することがあります。

今後の計画

現在のWebhook機能は「広告メール受信拒否番号登録」イベントにのみ提供されているため、提供範囲が限定的です。今後は、メールの送信ステップ別に定義したイベントの幅を広げ、PushやKakaoTalk BizmessageにもWebhook機能を提供する予定です。

TOAST Meetup 編集部

TOASTの技術ナレッジやお得なイベント情報を発信していきます
pagetop