送信 Webhook

OutgoingWebhook は、自動化イベントの送信先となる外部エンドポイントの設定を表します。「送信 (Outgoing)」とは、Portant プラットフォームから外部の宛先へイベントが送出されることを指します。

Portant が送信するイベントの詳細については、Webhook 経由で Portant からのイベントを受信するを参照してください。

フィールド

フィールド	型	説明
id	String	送信 Webhook 設定の ID。
webhookUrl	String	イベントが POST される Webhook のアドレス。

{
    "id": "owc_XY1Ys4gqrpX8cp",
    "webhookUrl": "https://webhook.site/d22c56ab-40ac-4f9a-93ef-02520235c0da"
},

GET /workflows/<wkf_id>/outgoing-webhooks/

特定のワークフローに対する送信 Webhook の設定を取得します。

ステータス	ボディ
200 OK	OutgoingWebhook
403 Unauthorised	Error

POST /workflows/<wkf_id>/outgoing-webhooks/

特定のワークフローに対する送信 Webhook の設定を作成します。

リクエストボディには、イベントを受信する URL を指定した webhookUrl フィールドを 1 つ含める必要があります。

{
    webhookUrl: "https://..."
}

PATCH /workflows/<wkf_id>/outgoing-webhooks/

特定のワークフローに対する送信 Webhook の設定を更新します。

リクエストボディには、イベントを受信する URL を指定した webhookUrl フィールドを 1 つ含める必要があります。

{
    webhookUrl: "https://..."
}