Webhookを使用したBiginデータの他のアプリケーションへの送信

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

Webhookを使用すると、自動化処理の一環としてBiginのデータを他のアプリケーションに送信できます。ワークフロールールやステージにおける自動化処理に、処理としてWebhookを追加します。商談が新しいステージに移動したり、連絡先が作成されたり、項目の値が変更されたりして自動化処理が実行されるたびに、選択したデータの登録内容がBiginから指定のURLに送信されます。受信側のアプリは、その内容に基づいて即座に処理を実行できます。

例として、商談が受注になったタイミングで実行されるワークフロールールから、請求ツールに通知するWebhookを呼び出せば、データを再入力せずに請求処理を開始できます。同様に、新規連絡先が作成されたタイミングで実行されるワークフロールールから、連絡先の詳細をマーケティングツールやサポートツールに送信するWebhookを呼び出せば、すべてのシステムで同期を維持できます。

メモ：

プラン：Bigin 360、Zoho One。

利用可能なユーザー：開発者権限の外部連携権限を持つユーザー。

上限：

追加する処理の種類	ワークフロールールごとの上限
即時処理	Webhook 1件
時間基準の処理	Webhook 1件、実行予定は最大5件

ステージにおける自動化処理1件につき、Webhookを1件設定できます。
API呼び出しの上限：Webhookの呼び出しは、組織全体で1日あたり最大500,000回、またはユーザー1人につき1日あたり500回のうち、先に到達した方が上限となります。

Webhookの設定

Webhookの設定は、次の3つの手順で行います：

Webhookを作成します。
パラメーターを設定します。
Webhookをワークフロールールまたはステージにおける自動化処理に関係付けます。

Webhookの作成

Webhookでは、Biginからのデータの送信先と、要求の認可方法を指定します。

［設定→自動化処理→Webhook］に移動します。
［+ Webhook］をクリックします。
次の詳細情報を入力します：

［名前］：Webhookの名前を入力します。
［説明］：Webhookの動作について短い説明を追加します。
［タブ／パイプライン］：Webhookを適用するタブまたはパイプラインを選択します。
［メソッド］：HTTPメソッドを選択します：POST、PUT、GET、またはDELETE。
［通知先URL］：データを受信するアプリのURLを入力します。
［認可の種類］：［全般］、または保存済みの［外部連携］を選択します。

例として、チームがBiginのパイプラインで製品の開発計画を管理し、ステージとして［計画済み］、［処理中］、［出荷済み］を使用しているとします。機能をリリースすると、常に誰かがWebサイトの［最新情報］セクションを手動で更新する必要があります。この作業を自動化するには、製品の開発計画のパイプライン用にWebhookを作成し、通知先URLとしてWebサイトの更新用URLを入力します。

パラメーターの設定

パラメーターでは、Biginが各要求とともに送信するデータを指定します。ヘッダーパラメーターには、コンテンツの種類、認可、ルーティングのメタデータなど、要求の送信元や処理方法に関する情報を指定します。ヘッダーパラメーターは、すべてのメソッドで使用できます。本文パラメーターにはデータの登録内容を含めることができ、POSTとPUTでのみ使用できます。GETとDELETEでは、代わりにURLパラメーターとしてデータが送信されます。

a）POSTとPUT -ヘッダーパラメーターと本文パラメーター。

b）GETとDELETE -ヘッダーパラメーターとURLパラメーター。

Webhookのパラメーターのセクションで、必要なパラメーターを追加します。
各パラメーターについて、次のいずれかを選択します：

Biginのタブの項目を関連付けて、データの登録内容を送信します。1つのWebhookで、商談、連絡先、組織、ユーザーなど、複数の関連するタブの項目を関連付けることができるため、これらすべてのデータを1つの要求にまとめられます。
独自の値を入力します。
差し込み項目を使用して、値を動的に挿入します。

POSTとPUTの要求では、本文の形式を選択します：なし、フォームデータ、または生データ。
［保存する］をクリックします。

前述の例では、製品の開発計画のパイプラインから商談の名前と説明を本文パラメーターに関連付けると、機能の名前と詳細をWebサイトに送信できます。同じWebhookで、ユーザータブから商談の担当者の名前も関連付けると、最新情報の各記事に、その機能をリリースしたプロダクトマネージャーの名前を記載できます。

Webhookとワークフロールールまたはステージにおける自動化処理との関係付け

Webhookは、ワークフロールールまたはステージにおける自動化処理によって処理として実行された場合にのみ、データを送信します。いずれかに追加することで、Webhookを実際の実行タイミングに関連付けられます。

ワークフロールールまたはステージにおける自動化処理を作成または編集します。
Webhookを処理として追加します。
作成したWebhookを選択します。
［保存する］をクリックします。

この設定が完了すると、データがルールの条件を満たす場合、Biginは常に設定済みのデータを外部アプリに自動送信します。

前述の例では、商談が［出荷済み］ステージに移動したタイミングで実行される、ステージにおける自動化処理にWebhookを追加します。以降、Biginで機能を［出荷済み］にすると、常に更新内容がWebサイトに自動送信され、顧客は公開後すぐにその内容を確認できます。

メモ：

Webhookは、ワークフロールールまたはステージにおける自動化処理に処理として追加した後にのみ実行されます。
Webhookの呼び出しに失敗した場合は、［失敗したデータ］タブで状況を確認し、もう一度試すことができます。
Webhookの呼び出し総数は、［使用状況］タブで確認できます。