Webhookを設定する

RunbookでWebhookを設定すると、ワークフローの任意のタイミングで、フォームに入力した情報を外部サービスに送信します。例えば、ワークフローのプロセスが進行したタイミングでその内容をチャットサービスに投稿するなどの使い方ができます。

Webhookを設定する

ブック(ワークフロー)設定のメニューから、「アクション」を開きます。

Webhookアクションを追加する

「アクションを追加する」>「Webhookアクションを追加する」をクリックします。

名称

任意の名称を入力します。

URL

情報を送信する外部サービスのURLを入力します。URLは連携する外部サービスによって異なります。詳細はそれぞれの外部サービスのマニュアル等をご覧ください。

Yoomとの連携例

実行するタイミング

Webhookを送信するタイミングを設定します。ワークフローの完了時、またはワークフローの進行時にアクションを実行できます。

送信されるデータ

RunbookからJSON形式の通知が送信されます。

通知データの詳細は、次のとおりです。

パラメーター

データ型

説明

event

string

イベントの種類

"complete_process": プロセスの完了

"proceed_after": タスクの完了

"proceed_before": タスクの開始

book_id

string

ブックID

run_id

string

プロセスID

current_state

string

現在処理中のタスク(記事)名

creator

string

作成者のメールアドレス
※ログインユーザーが作成したプロセスのみ

created_at

datetime

プロセスの作成日時

updated_at

datetime

プロセスの更新日時

assignees

string[]

担当者のメールアドレス
※担当者が設定されている場合のみ

url

string

プロセスのURL

public_url

string

外部公開URL
※外部公開されている場合のみ

properties.name

string

プロパティ名

properties.type

string

プロパティの型

properties.value

any

プロパティの値

送信される通知の例

{ "event": "proceed_before", "book_id": "bk_3jr4vap27ed0gangfredhbq7hv", "run_id": "rs_56c9sk22ryxrjj3ke3n9kdr628", "current_state": "フォームの配置", "properties": { "1:5gaawd66rs4qd37kbq8ffjan6h": { "value": "山田 ケンジ", "name": "お名前", "type": "text" },
"2:622e2wgnc04pe0zwgdax6sr5qa": { "value": "導入について相談したい。", "name": "お問い合わせの内容", "type": "textarea" }, "2:763xwg4bwxzczkd8g42szx0sqe": { "value": "2024-11-18T16:19:02+09:00", "name": "日時", "type": "datetime" }, "2:0x5q870kb83ev6naqb7tzaghhv": { "value": [ "確認しました" ], "name": "チェックボックス", "type": "checkbox" }, }, "created_at": "2024-11-19T11:57:37+09:00", "updated_at": "2024-11-19T11:57:37+09:00", "url": "https://sample.runbook.jp/run_states/rs_56c9sk22ryxrjj3ke3n9kdr628", "creator": "yamada@runbook.jp", "assignees": [ "sato@runbook.jp", "takahashi@runbook.jp" ] }