メインコンテンツへスキップ

Webhook送信アクションを作成する

更新

機能の概要

他のSaaSとの連携を設定する際に使用します。
例えば、エンドユーザーがプロジェクト内の特定のルートを通過したことを他のSaaSに通知することができます。
それでは、Webhook送信アクションを作成するための手順をご案内します。
 

操作手順

  1. 任意のスペースをクリックします。
  2. 任意のプロジェクトをクリックします。
  3. 「アクション」タブをクリックします。
  4. 「+ 新しいアクションを作成する」ボタンを押します。
  5. 「Webhook送信」をクリックします。
    新規登録の際、「テンプレートから作成」、「+ 新規作成」を選択することが可能です。
    「テンプレートから作成」を選択した場合はこちら
    「+ 新規作成」を選択した場合は、次のステップへお進みください。
  6. 「アクションの名前」と「説明」を入力します。
  7. 次の手順から、連携するサービスで公開されている仕様に沿って設定していきます。
    1. 「送信先URL」に、使用するWebhookのエンドポイント（URL）を入力します。
    2. 「 HTTPメソッド」を選択します。
      設定可能なHTTPメソッドは次の通りです。
      1. GET
      2. POST
      3. PUT
      4. DELETE
    3. 「ヘッダの名前」と「ヘッダーの値」を入力します。
      複数入力する必要がある場合は「+」ボタンで追加してください。
      連携するサービス側で指定が無い場合は不要です。
    4. 「送信内容の形式」で、送信するデータのフォーマットを選択します。
      対応するフォーマットは次の通りです。
      • json
      • text
    5. 「リクエストボディ」に、「送信内容の形式」で選択したデータの形式に沿ってデータの入力をし、「保存する」ボタンを押すことで設定完了となります。
 

その他仕様

また、アクション中では、次のデータを使用することもできます。
 

データ項目

データ項目を利用する時に使用します。
設定方法は次の通りです。
  1. 「データ項目」タブをクリックします。
  2. 入力欄にカーソルを合わせ、対象のデータ項目の「追加（差し込みマーク）」をクリックすることで差し込み完了です。

共通変数

グローバル・スペース共通変数を利用する時に使用します。
設定方法は次の通りです。
  1. 「共通変数」タブをクリックします。
  2. 入力欄にカーソルを合わせ、対象の共通変数の「追加（差し込みマーク）」をクリックすることで差し込み完了です。

システム

form spice で自動生成される値などを利用する時に使用します。
差し込むことが出来る記述については次の通りです。
  • テナントID
    • 利用しているテナントのIDです。
  • スペースID
    • アクションが所属するスペースのIDです。
  • プロジェクトID
    • アクションが所属するプロジェクトのIDです。
  • セッションID
    • 公開プロジェクトで利用しているセッションに割り当てられたIDです。
  • パスエイリアス
    • 「プロジェクト詳細」で設定した「パスエイリアス」です。
設定方法は次の通りです。
  1. 「システム」タブをクリックします。
  2. 入力欄にカーソルを合わせ、対象の「追加（差し込みマーク）」をクリックすることで差し込み完了です。

入力項目の制限

アクションの名前（必須項目）

  • 制約
    • 256文字以下
    • 全文字種登録可能

説明

  • 制約
    • 256文字以下
    • 全文字種登録可能

送信先URL（必須項目）

  • 制約
    • URL形式であること
    • http / https から始まること

HTTPメソッド（必須項目）

  • 制約
    • 指定していること

ヘッダー設定

  • 制約
    • 10件以下
    • ヘッダーの名前（必須項目）
      • 256文字以下
      • 使用可能文字種
        • 半角英小文字
        • 半角英大文字
        • 半角数字
        • 記号
          • !（エクスクラメーションマーク）
          • #（シャープ）
          • $（ドルマーク）
          • %（パーセント）
          • &（アンパサンド）
          • '（シングルクォーテーション）
          • *（アスタリスク）
          • +（プラス）
          • \（バックスラッシュ）
          • -（ハイフン、マイナス）
          • .（ドット）
          • ^（ハット）
          • _（アンダースコア）
          • `（バッククォート）
          • |（縦線）
          • ~（チルダ）
    • ヘッダーの値
      • 1024文字以下
      • 使用可能文字種
        • 半角英小文字
        • 半角英大文字
        • 半角数字
        • 記号
          • !（エクスクラメーションマーク）
          • "（ダブルクォーテーション）
          • #（シャープ）
          • $（ドルマーク）
          • %（パーセント）
          • &（アンパサンド）
          • '（シングルクォーテーション）
          • (（左かっこ）
          • )（右かっこ）
          • *（アスタリスク）
          • +（プラス）
          • ,（カンマ）
          • -（ハイフン、マイナス）
          • .（ドット）
          • /（スラッシュ）
          • :（コロン）
          • ;（セミコロン）
          • <（小なり）
          • =（イコール）
          • >（大なり）
          • ?（クエスチョンマーク）
          • @（アットマーク）
          • [（左ブラケット）
          • ]（右ブラケット）
          • ^（ハット）
          • _（アンダースコア）
          • `（バッククォート）
          • {（左中かっこ）
          • |（縦線）
          • }（右中かっこ）
          • ~（チルダ）
        • 半角スペース

送信内容の形式（必須項目）

  • 制約
    • 指定していること

リクエストボディ（必須項目）

  • 制約
    • 10,000文字まで
    • 全文字種登録可能

関連記事

Powered by Zendesk