Portant からのイベントを Webhook で受け取る

オートメーションが実行されたときに Portant からご自身のサーバーへ POST リクエストを送信させることができます。ワークフローに Send Webhook Events (Webhook イベントの送信) ブロックを追加すると、処理されたソースアイテムごとに Portant がリクエストを発火します。

イベントはソースアイテム単位で送信されます。ソースアイテムとは、ソースデータの1つの単位です (例: Google Sheets の1行)。オートメーションが複数のソースアイテムを対象として実行された場合、Portant はアイテムごとに1つの Webhook を送信します。

ペイロードのスキーマ

Portant が送信するすべてのイベントは、同じトップレベルの構造を共有します。data の内容は event_type によって異なります。

フィールド	説明
`event_id`	このイベントのために生成された一意の ID。
`event_type`	イベントの種類。`data` の内容を決定します (以下のイベントタイプを参照)。
`data`	イベントのペイロード。スキーマは `event_type` によって異なります。

スキーマの例

{
  "data": {
    ... // Determined by the type of event
  },
  "event_id": "325d36e717d9ec0943a55857ae2d4988ce33fe4165330e4f",
  "event_type": "<EVENT_TYPE>"
}

イベントの種類

Portant は現在4種類のイベントタイプを送信します。受け取るイベントタイプはワークフローの構成によって異なります。たとえば、ワークフローにメールブロックが含まれている場合にのみ EMAILS_CREATED を受け取ります。

ドキュメントが作成された場合

オートメーションが新しいドキュメント (Google Docs、Google Slides、または PDF) を作成しました。

ワークフローの設定

ワークフローにテンプレートブロック (Google Docs または Google Slides) が含まれている必要があります。

スキーマ

フィールド	説明
`documents`	このソースアイテムに対して作成されたすべてのドキュメントの配列。
`documents.id`	ファイルの Google Drive ID。
`documents.url`	ファイルの Google Drive URL。
`documents.name`	Google Drive 上に表示されるファイル名。
`documents.mimetype`	ファイルの MIME タイプ (以下を参照)。

MIME タイプ

Mimetype	説明
`application/vnd.google-apps.document`	Google Docs ファイル
`application/vnd.google-apps.presentation`	Google Slides ファイル
`application/pdf`	PDF ドキュメント

ペイロードの例

{
  "data": {
    "documents": [
      {
        "id": "12XXXXX..................",
        "url": "https://docs.google.com/document/d/12XXXXX................../edit?usp=drivesdk",
        "name": "Invoice #1200",
        "mimetype": "application/vnd.google-apps.document"
      },
      {
        "id": "13XXXXX..................",
        "url": "https://drive.google.com/file/d/13XXXXX................../view?usp=drivesdk",
        "name": "Invoice #1200",
        "mimetype": "application/pdf"
      }
    ]
  },
  "event_id": "325d36e717d9ec0943a55857ae2d4988ce33fe4165330e4f",
  "event_type": "DOCUMENTS_CREATED"
}

メールが作成された場合

オートメーションがメールを作成して送信しました。このイベントは署名リクエストに対しては発火しません。

ワークフローの設定

ワークフローにメールブロック (Gmail) が含まれている必要があります。

スキーマ

フィールド	説明
`emails`	このソースアイテムに対して作成されたすべてのメールの配列。
`emails.message_id`	Gmail のメッセージ ID。
`emails.to`	受信者アドレスをカンマ区切りで並べた文字列。
`emails.subject`	メールの件名。

ペイロードの例

{
  "data": {
    "emails": [
      {
        "to": "contact@portant.co",
        "subject": "Hello World",
        "message_id": "18xxxx........."
      }
    ]
  },
  "event_id": "eac17961e3edcfafcc064015131e8a518c9f375005b8cec2",
  "event_type": "EMAILS_CREATED"
}

署名がリクエストされた場合

オートメーションが署名リクエストを送信しました。

ワークフローの設定

ワークフローに署名リクエストブロックが含まれている必要があります。

スキーマ

フィールド	説明
`documents`	このソースアイテムに対して作成されたドキュメントの配列。`Documents created` イベントと同じ構造です。
`recipients`	ワークフロー内の署名リクエスト受信者の配列。
`recipients.email`	受信者のメールアドレス。
`recipients.order`	この受信者が署名する順番。
`recipients.status`	現在のステータス。このイベントでは常に `"PENDING"` です。
`recipients.signature_url`	受信者がリクエストを完了できる署名ポータルの URL。

ペイロードの例

{
  "data": {
    "documents": [
      {
        "id": "10XXXXX.................",
        "url": "https://drive.google.com/file/d/10XXXXX................./view?usp=drivesdk",
        "name": "Employment Contact",
        "mimetype": "application/pdf"
      }
    ],
    "recipients": [
      {
        "email": "bwlockley@gmail.com",
        "order": 1,
        "status": "PENDING",
        "signature_url": "https://sign.portant.co/xxxxxxxxxxxxx"
      }
    ]
  },
  "event_id": "66de24a8c20fa439d47d92a683861f6852c2924632623377",
  "event_type": "SIGNATURES_REQUESTED"
}

署名の完了

自動化内のすべての署名リクエストが完了しました。

ワークフローの設定

ワークフローに署名リクエストブロックが含まれている必要があります。

スキーマ

Signatures requested イベントと同じです。すべての受信者に対して recipients.status フィールドが "COMPLETED" になります。

ペイロードの例

{
  "data": {
    "documents": [
      {
        "id": "10XXXXX.................",
        "url": "https://drive.google.com/file/d/10XXXXX......../view?usp=drivesdk",
        "name": "Employment Contact",
        "mimetype": "application/pdf"
      }
    ],
    "recipients": [
      {
        "email": "bwlockley@gmail.com",
        "order": 1,
        "status": "COMPLETED",
        "signatureUrl": "https://sign.portant.co/xxxxxxxxxxxxx"
      }
    ]
  },
  "event_id": "72c32ca744baea46b4be710f052b14a9b73a29d77076e586",
  "event_type": "SIGNATURES_COMPLETED"
}