イベントテンプレートを作成

curl --request POST \
  --url https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "objectType": "<string>",
  "tokens": [
    {
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "objectPropertyName": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "detailTemplate": "<string>",
  "headerTemplate": "<string>"
}
'

{
  "id": "<string>",
  "name": "<string>",
  "objectType": "<string>",
  "tokens": [
    {
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "objectPropertyName": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "detailTemplate": "<string>",
  "headerTemplate": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

v3 event types external

Create an event template

deprecated

イベントテンプレートは、カスタムタイムラインイベントの全般的な構造を定め、HubSpotにイベントデータを送信可能にします。テンプレートには、カスタムプロパティーの定義以外にも、書式設定された見出しと詳細のコピーが含まれます。1つのアプリに含めることができるイベントテンプレートは最大750件です。

「v1」および「v3」タイムラインイベントAPIを使用できるのは、公開アプリに既存の「v1」または「v3」タイムラインイベントを定義しているアプリパートナーのみです。

アプリにまだタイムラインイベントが含まれていない場合、このエンドポイントへのリクエストは失敗します。代わりに、開発者プラットフォームの最新バージョンで始めることができます。承認を申請する前に、アプリのアプリイベントを定義する必要があることに注意してください。詳しくは、アプリイベントの概要をご確認ください。
アプリに「v1」/「v3」タイムラインイベントが含まれている場合は、開発者プラットフォームに移行する方法をご確認ください。既存のイベントタイプを移行する前に承認を申請する必要はありません。

アプリパートナーでない場合は、カスタムイベントAPIを使用してカスタムイベントデータをHubSpotに送信できます。

POST

integrators

timeline

{appId}

event-templates

イベントテンプレートを作成

curl --request POST \
  --url https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "objectType": "<string>",
  "tokens": [
    {
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "objectPropertyName": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "detailTemplate": "<string>",
  "headerTemplate": "<string>"
}
'

{
  "id": "<string>",
  "name": "<string>",
  "objectType": "<string>",
  "tokens": [
    {
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "objectPropertyName": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "detailTemplate": "<string>",
  "headerTemplate": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Supported products

承認

Authorization

string

header

必須

The access token received from the authorization server in the OAuth 2.0 flow.

パスパラメータ

appId

integer<int32>

必須

ターゲットアプリのID。

ボディ

application/json

name

string

必須

テンプレート名。

objectType

string

必須

このテンプレートが［コンタクト、会社、チケット、取引］についてサポートされているCRMオブジェクトのタイプ。

tokens

object[]

必須

イベントのカスタムプロパティーとして使用でき、完全なCRMオブジェクトを作成するためのトークンのコレクション。

Show child attributes

detailTemplate

string

詳細を展開すると、Handlebarsとイベント固有のデータを含めてMarkdown構文を使用してタイムラインでHTMLがレンダリングされます。

headerTemplate

string

ヘッダーとして、Handlebarsとイベント固有のデータを含めてMarkdown構文を使用してタイムラインでHTMLがレンダリングされます。

レスポンス

successful operation

string

必須

テンプレートID。

name

string

必須

テンプレート名。

objectType

string

必須

このテンプレートが［コンタクト、会社、チケット、取引］についてサポートされているCRMオブジェクトのタイプ。

tokens

object[]

必須

イベントのカスタムプロパティーとして使用でき、完全なCRMオブジェクトを作成するためのトークンのコレクション。

Show child attributes

createdAt

string<date-time>

イベントテンプレートが作成された日時（ISO 8601タイムスタンプ）。テンプレートが2020年2月18日より前に作成された場合はnullになります。

detailTemplate

string

詳細を展開すると、Handlebarsとイベント固有のデータを含めてMarkdown構文を使用してタイムラインでHTMLがレンダリングされます。

headerTemplate

string

ヘッダーとして、Handlebarsとイベント固有のデータを含めてMarkdown構文を使用してタイムラインでHTMLがレンダリングされます。

updatedAt

string<date-time>

イベントテンプレートが最後に更新された日時（ISO 8601タイムスタンプ）。テンプレートが2020年2月18日より前に作成された場合はnullになります。

Last modified on April 13, 2026

Add tokens to an existing template

Get an event template

⌘I

Documentation Index

承認

パスパラメータ

ボディ

レスポンス