コンテンツにスキップ
PynPyn

ステップのオプション

以下の表は、ステップが持つ各フィールドをアプリでのラベルとともに、保持する値とあわせて示します。MCPツールとエクスポートが使うのも同じ形なので、Pynを自動化する人のためのリファレンスです。

すべてのステップにあるフィールド

Section titled “すべてのステップにあるフィールド”
フィールド アプリでのラベル 値
id Pynが割り当てる一意のid。
title ステップのタイトル 自由なテキスト。空ならステップの種類が表示されます。
type Add Stepで選択 send-message、send-channel-message、invite-to-calendar-event、send-channel-invite、raise-ticket、add-message-to-context。下記を参照してください。
state Enabled / Disabled enabledまたはdisabled。無効なステップが送信されることはありません。
schedule.type オートメーションではrelativeまたはelapsed(After trigger)、キャンペーンではabsolute。
schedule.offset Schedule relativeでは{ "days": -7 }や{ "weeks": 2 }のような期間。負の値は基準日より前です。elapsedでは、トリガーの時点から後の正の期間をminutes、hours、days、weeksで指定します(例:{ "hours": 1 })。{}はImmediatelyです。
schedule.date Scheduled date absoluteでは暦日。2026-03-02。
schedule.hour、schedule.minute at 0から23と0から59。
schedule.timezone in recipient、またはAustralia/Sydneyのようなタイムゾーン名。
schedule.deliverOn Days of Week MONDAYからSUNDAYのうち1つ以上。
schedule.onSkippableDate On Non-Delivery Days deliver-anyway、deliver-before(前の配信日)、またはdeliver-after(次の配信日)。
audience Audienceタブ lifecycle(current、joiner、leave、terminatedのうち任意のもの)、includeGroups、excludeGroups(グループのid)。ないときは在籍中の従業員のみです。
skipIfOverdue Skip if overdue at enrollment 誰かがエンロールされた時点で日付が過ぎているステップをスキップするにはtrue。
reminders Reminders ステップのサイドパネルでは3件まで(3件でAdd reminderが消えます)。それぞれoffset(送信後の日数)、enabled、そしてサイドパネルでは設定しない任意のmessageを持ちます。APIやMCPサーバー経由で書かれたステップは10件まで持てます。

schedule.hour、schedule.minute、schedule.timezone、schedule.deliverOn、schedule.onSkippableDateは、relativeまたはabsoluteのスケジュールにだけ存在します。elapsedのスケジュールが持つのはtypeとoffsetだけで、キャンペーンのステップでは使えません。

send-message(ダイレクトメッセージまたはメール)とsend-channel-message(チャンネル投稿)には次が加わります。

フィールド ラベル 値
medium ステップの種類で固定 slackまたはemail。
sender From 送信者のid。ないときはワークスペースの既定です。
conditionalSender From 条件付き送信者のid。ステップが持つのはsenderかconditionalSenderのどちらか一方で、両方は持ちません。
recipient To 受信者。下記を参照してください。チャンネル投稿の受信者はチャンネルです。
ccRecipients Cc 受信者の一覧で、数は任意です。ステップのサイドパネルではToの横のCcリンクの先にあります。
subject Subject 1行のドキュメント。メールでは件名です。Slackのダイレクトメッセージでは、fallbackToEmailが設定されているときに送られるメールの件名です。
message エディター 作成されたメッセージ。
body、html Email body Raw HTMLメールではbody: "html"とし、LiquidのHTMLをhtmlに入れます。それ以外では作成されたmessageが本文です。メールのみ。
emailFormat Email format leftまたはfull-width。ない場合はCenteredです。作成メッセージのメールのレイアウトだけを決め、Raw HTMLメールは書かれたとおりに送られます。
hideSignature Include the sender’s signature (verified email senders) スイッチのチェックを外すとtrue。ない場合は、検証済みメール送信者の署名がメールの末尾に入ります。作成メッセージのメールのみ。
deactivateUnfurlLinks、deactivateUnfurlMedia Advanced Slackのプレビューを止めるにはtrue。
fallbackToEmail、fallbackEmailSender Send by email if the recipient is not in Slackと、その下のFrom Slackのダイレクトメッセージで、trueとメール送信者のid。Slackにいない受信者には、その送信者から、ステップのsubjectを件名としてメッセージがメールで送られます。送信者と件名がないままfallbackToEmailが設定されている間は、オートメーションを公開できません。Slackにいない人にダイレクトメッセージをメールで送るを参照してください。
escalations Escalations 3件まで。それぞれoffset(送信後の日数)、recipient(グループと条件付き受信者を除く任意の受信者)、enabledを持ちます。
形 ラベル フィールド
相対 Employee、Manager、Skip-level Manager、Buddy、HRBP type: "relative"、recipientはemployee、manager、skip-manager、buddy、hrbpのいずれか。任意のaddressはprimaryまたはpersonal。
個人 People type: "employee"、recipientは従業員のid、任意のaddress。
グループ Groups(キャンペーンのステップ) type: "group"、recipientはグループのid。すべてのメンバーがステップを受け取ります。
チャンネル Channels type: "channel"、recipientはチャンネルのid。
カスタムメールアドレス Custom Email Recipients type: "custom-email"、recipientはカスタムメール受信者のid。
条件付き受信者 Conditional Recipients type: "conditional"、recipientは条件付き受信者のid。エンロールされた従業員ごとにそのルールから解決されます。キャンペーンのステップでは拒否されます。
種類 Add Stepでのラベル 追加のフィールド
invite-to-calendar-event Invite to Calendar Event recipient(既定はEmployee。サイドパネルにはそのためのコントロールがありません)、eventId(カレンダーイベント)、inviteToはnext-occurrence、next-occurrence-reference-date、all-occurrencesのいずれか。
send-channel-invite Add to Channel sender、recipient(追加される人)、channel(チャンネルのid)、medium: "slack"。
raise-ticket Raise Ticket integration(Jiraの接続)、project、issueType、summary(1行)、description、medium: "jira"。受信者はありません。
add-message-to-context Add Message to Employee Contextと他のAI & Contextの行 recipient(誰のコンテキストか)。

キャンペーンテンプレートのマイルストーン

Section titled “キャンペーンテンプレートのマイルストーン”

キャンペーンテンプレートはマイルストーンの一覧で、それぞれid、title、emoji、color(16進数の色)、date(暦日)、steps(上記のステップ。絶対スケジュール付き)を持ちます。マイルストーンをエンロールすると、その日付を基準日とするキャンペーンになります。キャンペーンテンプレートを参照してください。