自動化ワークフローから Webhook を呼び出す

以下の各セクションでは、自動 bot から Webhook を呼び出す方法を説明します。

 

AppSheet Core のアカウントの場合: Workspace AppSheet Core セキュリティ違反エラーが発生する場合は、この機能の使用はポリシーで許可されていません（AppSheet へのアクセスを管理するの説明を参照）。サポートについては、Workspace の管理者にお問い合わせください。

Call a webhook タスクを追加して構成する

以下の手順に沿って、Call a webhook タスクを追加して構成します。

  1. bot にタスクを追加するで説明しているように、Call a webhook タスクを bot に追加します。
  2. 以下の表で説明しているプロパティを設定して、Call a webhook タスクを構成します。
  3. 完了したら、次のいずれかを選択してアプリを保存します。
    • Save - アプリを保存します。
    • Save & verify data - アプリを保存し、外部依存関係に基づいてアプリが実行可能であるかどうかを確認します。

アプリを保存すると、他の bot でタスクを再利用できるようになります。

以下の表で説明されている設定を使用して、Call a webhook タスクを構成します。

設定

説明
Linking

 

[Linking] パネルを開き、Linking 設定を切り替えることで、このコンポーネントの再利用を有効または無効にします。自動化コンポーネントを再利用するをご覧ください。

Expand the Linking panel and toggle the Linking setting to enable or disable component reuse

Task name
タスクの名前。アプリ内で一意である必要があります。
注: この設定は、[Linking] がオンの場合にのみご利用いただけます。

Table name

イベント内で定義され、このタスクで使用されるテーブル。

選択したテーブルの構造を表示または編集するには、フィールドにカーソルを置いて Edit icon をクリックします。詳しくは、テーブル: 基礎をご覧ください。

注: イベントとは異なるテーブルを使用するには、Call a process のステップを追加します。

Preset

すべての設定をカスタマイズするか、プリセットを選択して値のサブセットを事前入力するかを選択します。

有効な値は次のとおりです。

  • Custom - 全構成値を手動で設定します。この設定はデフォルトです。
  • Slack Hook - Slack webhook の値を事前入力します。
  • AppSheet API - AppSheet API の値を事前入力します。

URL

HTTP リクエストのウェブサービスの URL。絶対 URL でなければならず、テキスト、変数、式を含めることができます。

例:

https://api.webservice.com/add/table/<<[Table Name]>>/id/<<[Record Id] + 1>>


Webhook を使用して AppSheet API を呼び出す場合は、次の形で Webhook URL を入力します。
https://api.appsheet.com/api/v2/apps/{appId}/...
    tables/{tableName}/Action

各要素の意味は次のとおりです。

  • {appId} は AppSheet アプリの GUID を示します。[Manage] > [Integrations] > [IN] ペインで確認できます。
  • {tableName} はテーブルの名前を示します。

アプリがテストモードの間（つまり、デプロイ チェックを通過していない間）、Webhook を呼び出すことができます。これにより、アプリがデプロイされる前に Webhook をテストできます。

注: この設定は、[Preset] を [Custom] または [Slack Hook] に設定している場合にのみご利用いただけます。

HTTP 動詞

HTTP 動詞を使用してウェブサービスを呼び出します。リストから値を選択します。有効な値は、Delete、Get Patch、Post（最も一般的）、Put です。

注: この設定は、[Preset] を [Custom] に設定している場合にのみご利用いただけます。

HTTP Content Type

本文のコンテンツ タイプ有効なコンテンツのタイプは、以下のとおりです。

  • CSV
  • FORM_URL_ENCODED
  • HTML
  • ICS_Calendar
  • JSON
  • PDF
  • XLSX（Microsoft Excel 形式）
  • XML

デフォルトは JSON です。

注: この設定は、[Preset] を [Custom] に設定している場合にのみご利用いただけます。

App Id

リクエストを送信するアプリの ID。デフォルトは現在のアプリの ID です。

注: この設定は、[Preset] を [AppSheet API] に設定している場合にのみご利用いただけます。

Target Table Name

リクエスト送信先のアプリのターゲット テーブルの名前。

テーブルの追加の詳細については、テーブル: 基礎をご覧ください。

注: この設定は、[Preset] を [AppSheet API] に設定している場合にのみご利用いただけます。

Body

Webhook に送信するコマンドまたはデータを含む本文。

本文を定義するには、次のいずれかを行います。

  • テキスト、イメージ、変数、式を含む、Webhook 本文をこの設定に入力する。
  • 設定を空白のままにして、[Body Template] を指定する（以下の説明を参照）。
  • 設定と [Body Template] 設定をブランクのままにして、デフォルトのコンテンツを使用する。
注:

  • ユーザー設定にアクセスするには、Webhook タスクの JSON 本文で ANY(_Per user Settings[Column]) を使用します。現時点ではサポートされていないため、Webhook タスクの JSON 本文で USERSETTINGS() を指定しないでください。

  • この設定よりも [Body Template] の設定のほうが優先されます（指定した場合）。

デフォルトは、追加または更新された行のデータ値で、Hidden または Show で型指定された列を除きます。

HTTP Headers

HTTP リクエストに含まれる HTTP ヘッダーのリスト。

認証トークンやユーザー名とパスワードのような認証情報を含む Authentication ヘッダーを含むのが一般的です。HTTP Basic Authentication のヘッダーを指定するをご覧ください。

[Add] をクリックして以下の形式を使用した HTTP ヘッダーを追加します。

<ヘッダー>: <値> HTTP ヘッダーを追加するにはこれを繰り返します。

ヘッダー名とヘッダー値には、定数または AppSheet 式を含めることができます。式の結果は、HTTP ヘッダーの式を置き換えます。

ヘッダー値が引用符を含む場合、ヘッダー値全体を引用符で囲み、埋め込まれた引用符を 2 つの引用符でエスケープします。たとえば、ヘッダー名が Authorization で、ヘッダー値が Token token="537d7d" の場合、ヘッダー行に Authorization: "Token token=""537d7d""" を入力します。

デフォルトでは、AppSheet は Content-Type ヘッダーを、Content-Type: "application/json" のように設定します。

例:

Webhook から Pushpad を呼び出す場合、以下のヘッダー値を含める必要があるかもしれません。

  • Authorization: "Token token=""9474e7df4ba7c96a06"""
  • Accept: "application/json"
注: この設定は、[Preset] を [Custom] または [AppSheet API] に設定している場合にのみご利用いただけます。

Body Template

Webhook 本文をきめ細やかに制御するために使用するテンプレート。詳細については、bot でテンプレートを使用するおよび Body の設定の説明（上記）をご覧ください。

注: この設定は、[Preset] を [Custom] または [AppSheet API] に設定している場合にのみご利用いただけます。

Body Template Data Source

本文テンプレートで使用するデータソース。

注: この設定は、[Preset] を [Custom] または [AppSheet API] に設定している場合にのみご利用いただけます。
戻り値

ウェブサービスの呼び出しからの戻り値を取得するには、この切り替えを有効にします。詳細は Webhook からの戻り値を使用するをご覧ください。
Specific types

ウェブサービスの呼び出しからの戻り値を取得するには、この切り替えを有効にします。詳細は Webhook からの戻り値を使用するをご覧ください。

Timeout

AppSheet がタイムアウトする前に Webhook が完了するのを待つ秒数。デフォルトは 180 です。

Max number of retries on failure

問題発生時に Webhook を再試行する最大回数。デフォルトは 3 です。

Run asynchronously

AppSheet がバックグラウンド タスクとして非同期に実行するかどうかを指定する切り替え。Webhook を非同期で起動すると、クライアントの応答時間を改善できます。

この設定を行う前に、ご使用のアプリケーションが正しく動作するにあたって Webhook が同期的に実行完了する必要があるかどうかご検討ください。たとえば、データの変更が Webhook 側で行われており、アプリケーションは同期完了前にデータ更新が行われることに依存している場合、非同期の呼び出しを使用することで不正確な結果を生む場合があります。

デフォルトでは、この設定は無効になっています。

注: この設定は、[Return value] がオフの場合にのみご利用いただけます。

[Advanced] 設定を開き、以下の説明に合わせてカスタマイズします。

設定

説明

Inputs

タスクを動的に構成する入力値を追加します。詳細については、タスクで動的に入力値を設定するをご覧ください。

  1. [Advanced] セクションを開きます。
  2. [Inputs] で [Add] をクリックします。
  3. [Name] フィールドに入力値の名前を記入します。
  4. [Type] プルダウンからデータタイプを選択します。
    入力では、一部のデータタイプのみがサポートされています。
  5. 初期値を追加する、または項目を編集するには:
    1.  をクリックして入力ダイアログを開きます。
    2. [Initial value] フィールドに値または式を追加します。
      初期値を指定しなかった場合、値を入力するよう求められます。初期値を指定した場合、値の入力を省略できます。
      [Initial value] フィールドでは、[_THIS] または [_INPUT] の使用はサポートされていません。
    3. 必要に応じて他のフィールドを編集します。
    4. [Done] をクリックします。
  6. その他の入力値の追加を繰り返します。

現在の手順から入力値にアクセスするには、次の式を使用します: [_INPUT].[入力の名前]

HTTP Basic Authentication のヘッダーを指定する

HTTP Basic Authentication ヘッダーは以下のように指定できます。

  • ヘッダー名: Authorization 
  • ヘッダー値: Basic <Base64 でエンコードされた認証値>

Twilio を呼び出す場合、以下の形で Twilio Account SID、コロン、Twilio Auth Token の順に指定する必要があります。
<TwilioAccountSID>:<TwilioAuthToken>

例:

Twilio Account SID が BDe8de733fd2363d6d0d86719f6ad324db で、Twilio Auth Token が 5c3a028974b570eebc48fc4de2a5f567 の場合、認証値は以下のようになります。
BDe8de733fd2363d6d0d86719f6ad324db:5c3a028974b570eebc48fc4de2a5f567

この値を Base64Encode.org のようなウェブサービスを使用して Base64 UTF-8 エンコードすると、以下のような値が得られます。

QkRlOGRlNzMzZmQyMzYzZDZkMGQ4NjcxOWY2YWQzMjRkYjo1YzNhMDI4OTc0YjU3MGVlYmM0OGZjNGRlMmE1ZjU2Nw==

ヘッダー値は以下のようになります。

Basic QkRlOGRlNzMzZmQyMzYzZDZkMGQ4NjcxOWY2YWQzMjRkYjo1YzNhMDI4OTc0YjU3MGVlYm
M0OGZjNGRlMmE1ZjU2Nw==

この情報は役に立ちましたか？

改善できる点がありましたらお聞かせください。
true
検索
検索をクリア
検索を終了
Google アプリ
メインメニュー
14655757036965428163
true
ヘルプセンターを検索
true
true
true
false
false
false
false