APIを通じたシグナルの実行

APIを通じてシグナルを実行するのに適した場合

外部サービスにおいて、何か処理が発生した時にその詳細情報をPOSTリクエストで送信する機能があり、OAuth2.0認証に対応している場合が該当します。また、外部サービスにおいて、データ送信方法をカスタマイズできる場合にも、このメソッドを使用することもできます。
この場合、リクエストの本文にJSON形式で処理の詳細を記述し、シグナルのAPIを通じてPOSTリクエストを送信します。
APIを通じてシグナルを実行する場合、外部アプリケーションとZoho CRM間で外部連携を設定する必要がありますのでご注意ください。詳細については外部連携をご参照ください。

APIを通じて、カスタムシグナルを実行できます。

リクエストURL

https://www.zohoapis.com/crm/v2/signals/notifications

リクエストのメソッド

POST

属性

データの種類

必須

詳細

signal_namespace

文字列

必須

シグナル名（他のシグナルと重複しない専用の名前）。

subject

文字列

必須

シグナルの簡単な説明。最大100文字まで入力できます。

message

文字列

必須

シグナルの詳細な説明。最大1,000文字まで入力できます。

email/id

文字列

必須

シグナルを実行する見込み客か連絡先のメールアドレス、または、データID。

actions配列の詳細を表示

JSON配列

必須

外部拡張機能の詳細（表示するページの表示名、URL、リンクを開く方法など）。

actions配列の詳細

属性	データの種類	必須	詳細
type	文字列	必須	リンクとして指定された外部拡張機能の詳細ページを表します。このキーの値は、linkです。
open_in	文字列	必須	外部リンクを新しいタブで開くか、ポップアップ画面として開くかを表します。入力可能な値は、tabとpopupです。
display_name	文字列	必須	リンクの表示名を表します。
url	文字列	必須	外部拡張機能のURLを表します。

メモ

「message」キー内で、本文の書式を設定できます。書式のオプションは次のとおりです。
- 太字：アスタリスク（*）で本文を囲みます。例：*この本文が太字で表示されます。*
- 斜体：キャレット（^）で本文を囲みます。例：^この本文が斜体で表示されます。^
- 改行：~br~を使用すると、改行を挿入できます。他の2つのいずれかの書式設定を適用している場合、文中に改行は挿入できません。

POSTリクエストのボディのサンプル

{ "signals": [     {       "signal_namespace": "surveymonkey.responded",       "email": "p.boyle@xyz.com",       "subject": "Welcome Zoho CRM 2020",       "message": "*ZOHO Corporation* offers ~br~ ^Online Business,^ ~br~ ^Network and IT Infrastructure Management Applications,^ ~br~ ^Software Maintenance and Support Services^",       "actions": [         {           "type": "link",           "open_in": "popup",           "display_name": "View Email",           "url": "www.google.com"         }       ]     }   ] }