補足）Webhook RequestBodyの変数について – pottosガイドページ

■目次

概要

A．変数について

B．初期値の設定方法

C．フォーマットの指定方法

■概要

本記事では、トリガーアクションの「アクション：Webhook」にて、Request Bodyに「変数」を設定する際の入力方法についてご説明します。

Webhookの作成方法は「アクションの種類：G. Webhook」をご参照ください。

A．変数について

場所：NAVIGATION[ アクション ] > [ トリガーアクション ] > [ ＋（新しいトリガーアクション）] > [ アクションを追加 ] > [ Webhook ] > [ 変数を挿入 ]

pottosで言う変数とは、数値や文字などの値を入れられる領域のことを指します。

例えば、トリガーアクションのWebhookのRequest Bodyに「カスタマー名の変数」を指定しておくと、トリガーアクションが実行されたカスタマーの名前（ABC株式会社など）がWebhookで送信されます。

変数は以下より指定できます。

カスタマー	カスタマー名	{{customer_name}}
	カスタマーID	{{customer_id}}
	オリジナルカスタマーID	{{original_customer_id}}
	スコア合計	{{score}}
	担当者	{{incharge}}
	カスタム項目	{{custom_item(〇〇〇)}} ※〇〇〇にはカスタム項目名が入ります。
	MRR	{{mrr}}
	解約日	{{churn_date}}
	登録日	{{registration_date}}
日時	実行日付（YYYY-MM-DD）	{{date}}
	実行時刻（HH:mm）	{{time}}
	実行日時（UNIX）	{{unix}}
トリガーアクション	トリガーアクション名	{{trigger_action_label}}
	AND条件セグメント	{{has_all_segments}}
	OR条件セグメント	{{has_one_segments}}

B．初期値の設定方法

対象のデータがnull（空白値）の場合に、登録されるデータ（＝初期値）を設定できます。

◇参考
初期値の設定が可能な変数は以下の通りです。
・カスタム項目（データ型が「チェックボックス」の項目は除く）
・解約日
・AND条件セグメント
・OR条件セグメント

例）数値（カスタム項目 / 数値型）がnullの場合に、

初期値「0（数値）」を設定する場合のRequest Body（pottos API）

C．フォーマットの指定方法

日付または日時の変数を指定した場合に、データの出力形式を指定できます。

フォーマットに指定はありません。

◇参考
フォーマットの指定が可能な変数は以下の通りです。
・カスタム項目（データ型が「日付」または「日時」の項目のみ）
・解約日
・登録日
・実行日付（YYYY-MM-DD）
・実行時刻（HH:mm）
・実行日時（UNIX）

◇参考
・「年月日、時分秒」は以下のように指定すると出力する際に自動で置換されます。
年：YYYY / 月：MM / 日：DD / 時：HH / 分：mm / 秒：ss
・日付型（時間の情報を持たない）の変数を設定し、フォーマットで「YYYY/MM/DD HH:mm:ss」のように時分秒まで指定した場合、時分秒は00:00:00で出力されます。
・Asia/Tokyoタイムゾーンで出力されます。

◆注意
Webhookでpottosの日付項目または日時項目にデータを登録・更新する場合、日付は「-（ハイフン）」で区切る必要があります。（フォーマット未指定の場合はハイフン区切りで出力されます。）
・日付の場合：YYYY-MM-DD
・日時の場合：YYYY-MM-DD HH:mm:ss

（例）トリガーアクション実行日（カスタム項目 / 日付型）を登録する場合のRequest Body（pottos API）

「/（スラッシュ）」で区切った場合はエラーとなります。

このセクションの記事

■概要

A．変数について

B．初期値の設定方法

C．フォーマットの指定方法