概要
この記事では、スマレジのWebhookを利用してYoomのフローボットを起動する方法をご紹介します。
設定方法
① YoomでWebhookURLを取得
Yoomのフローボット編集画面でトリガーの中から「特定のアプリイベントが発生した時」を選択し、アプリ一覧から「スマレジ」を選択します。
トリガーアクションで「(即時起動)」と記載があるアクションがWebhookを利用したトリガーとなります。
設定を行う任意のトリガーアクションを選択してください。
次のページでWebhookURLが表示されるため、「コピー」ボタンでコピーをしておきます。
②スマレジでアプリを作成
こちらからスマレジDevelopersへアクセスし、アカウントを作成します。
アカウントを作成し、ログインしたらサイドバーの「アプリ」から「プライベートアプリ」を選択し、「プライベートアプリを新規登録」を選択します。
アプリ区分では「WEBアプリ」を選択し、アプリ名とアイコンは任意の情報を設定してください。
環境設定のページではそれぞれ下記のように設定を行い、「保存」ボタンをクリックしてください。
アプリのURL:https://yoom.fun
利用者契約通知先URL:https://yoom.fun
Webhook送信先エンドポイント:Yoomで取得した(コピーした)WebhookURL
また、開発環境と本番環境どちらも設定を行う必要があるので注意してください。
次にWebhookのページに移動します。
「Webhookの利用」で「利用する」を選択します。
「送信するイベント」部分では、Yoomのフローボットを起動したいイベントを選択し、「保存」ボタンをクリックします。
最後に、「利用状況」のページに移動し、「利用契約ID」を設定し、「アクティベート」を実行します。
※「利用契約ID」は上記で操作している開発ページ内のものではなく、実際に利用しているスマレジのアカウントページのものを使用してください。
その後、アクティベートを承認する認証メールが届くため、メール内のURLをクリックしてアクティベートを完了してください。
完了後、一度ログアウトして再度ログインする必要があるためご注意ください。
スマレジDevelopersの利用状況のページで、「利用中」と表示されていればアクティベートが完了しています。
③Webhookのテストを実行
問題なくYoomでWebhookを受け取ることができるかテストを実行します。
アプリ作成時に「送信するイベント」部分で選択したイベントを実際に実行してください。
例えば、「商品」のイベントを選択した場合、スマレジ上で実際に商品を登録、または商品情報の更新を行なってください。
その後、Yoomのトリガー設定ページに戻り、「テスト」ボタンを押してください。
「🎉Webhookの取得に成功しました!」と表示されれば、接続が完了しています。
アウトプット内に「イベント内容」「実行アクション」などの情報が取得できているはずです。
「実行アクション」の値に関しては、それぞれ下記の内容となります。
created: 登録
edited: 更新
deleted: 削除
bulk-update: 一括更新
bulk-deleted: 一括削除
以上で、スマレジのWebhookトリガー設定が完了です 🎉