カスタムAPIアクション

カスタムAPIアクションを使用して、HubSpot APIに対する認証済みのカスタムAPIリクエストを発行します。「HubSpot APIドキュメント」を参照してください。

オプション

フィールド定義タイプ必須
Request Type(リクエストタイプ) カスタムAPI呼び出しでサポートされているHTTPリクエストメソッド、つまりHTTP動詞を以下に示します(「HTTPリクエストメソッド」を参照)。
  • GET:パラメーターに基づいてWebサーバーからデータを取得します。このメソッドは指定されたリソースの表現を要求します。リクエストが成功した場合、要求したコンテンツとともに200 (OK)レスポンスメッセージが返されます。
  • POST: パラメーターに基づいてWebサーバーにデータを送信します(たとえば、ファイルのアップロードなど)。複数のPOSTリクエストは、単一のPOSTとは異なる結果になる場合があります。意図せず複数のPOSTリクエストを送信することを避けるために注意する必要があります。リクエストが成功した場合、200 (OK)レスポンスメッセージが返されます。
  • PUT: パラメーターに基づいてWebサーバーの特定の場所に格納されるデータを送信します(たとえば、ファイルのアップロードなど)。POSTリクエストとは異なり、PUTリクエストは等羃です。リクエストが成功する場合、単一のPUTリクエストの結果は同一のPUTリクエストを何回行っても同じです。リクエストが成功した場合、200 (OK)201 (Created)、または204 (No Content)レスポンスメッセージを受信します。
  • PATCH: パラメーターに基づいてWebサーバー上のリソースに部分的な変更を適用します。PATCHは冪等ではありません。複数のPATCHリクエストによって意図しない結果が生じる可能性があります。PATCHが成功した場合、200 (OK)または204 (No Content)レスポンスメッセージを受信します。
  • DELETE: パラメーターに基づいてWebサーバーから特定のリソース(存在する場合)を削除します。DELETEが成功した場合、200 (OK)レスポンスメッセージが返されます。
ドロップダウンTRUE

入力

フィールド定義タイプ必須
Relative URL(相対URL)

対話を試みるWebサーバーのURLアドレス。/{version}/{insert_remaining_URL}のように相対URLを指定します。「?」を使用して相対URL内にクエリーパラメーターを指定したり、クエリー入力内のオブジェクトキーペアとしてクエリーパラメーターを指定したりすることができます。

たとえば、HubSpot REST APIエンドポイントが

https://api.hubapi.com/crm/v3/properties/contactsの場合、相対URLは/crm/v3/properties/contactsです。

HubSpot APIドキュメント」を参照してください。

文字列TRUE
Headers (ヘッダー)承認またはコンテンツタイプ (これらはすでにこのコネクタで処理されている) に加えて必要な任意のヘッダーを指定します。オブジェクトFALSE
Query (クエリー)オブジェクト形式 (キーと値のペア) で含める必要がある追加のクエリーパラメーターを指定します。オブジェクトFALSE
Body (ボディー)リクエストボディーをJSON形式で指定します。POSTPUT、およびPATCH リクエストでのみ使用できます。オブジェクトFALSE

出力

フィールド定義タイプ
Status Code(ステータスコード)操作の結果。HTTPステータスコードはコネクタによって返され、カードによって実行されたアクションが成功したか失敗したかを示します。以下に例を挙げます。
  • 201 Createdステータスコードは、新しいリソースが作成された場合の成功を示します。
  • 403 Forbiddenエラーは、必要な権限が不足していたためにHTTPリクエストが処理されなかったことを示します。

発生する可能性があるステータスコードの完全なリストについては、「 HTTPステータスコード」を参照してください。

数値
Headers (ヘッダー)出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは選択されたHTTPリクエストオプションに依存します。すべてのヘッダーがレスポンスヘッダーではないことに注意してください。通常、{"Content-type":"application/json"}のようになります。オブジェクト
Body (ボディー)選択されたHTTPリクエストから返されるデータ (たとえば、GETリクエストからのデータなど)。オブジェクト

関連項目

HubSpot CRMコネクタ

Okta Workflowsの要素について

HubSpot APIドキュメント