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

curl --request POST \
  --url https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "PetSpot Registration",
  "objectType": "contacts",
  "headerTemplate": "Registered for [{{petName}}](https://my.petspot.com/pets/{{petName}})",
  "detailTemplate": "Registration occurred at {{#formatDate timestamp}}{{/formatDate}}\n\n#### Questions\n{{#each extraData.questions}}\n  **{{question}}**: {{answer}}\n{{/each}}",
  "tokens": [
    {
      "name": "petName",
      "label": "Pet Name",
      "type": "string"
    },
    {
      "name": "petAge",
      "label": "Pet Age",
      "type": "number"
    },
    {
      "name": "petColor",
      "label": "Pet Color",
      "type": "enumeration",
      "options": [
        {
          "value": "white",
          "label": "White"
        },
        {
          "value": "black",
          "label": "Black"
        },
        {
          "value": "brown",
          "label": "Brown"
        },
        {
          "value": "other",
          "label": "Other"
        }
      ]
    }
  ]
}'

{
  "id": "1001298",
  "objectType": "contacts",
  "createdAt": "2020-02-12T20:58:26Z",
  "updatedAt": "2020-02-12T20:58:26Z",
  "name": "PetSpot Registration",
  "headerTemplate": "Registered for [{{petName}}](https://my.petspot.com/pets/{{petName}})",
  "detailTemplate": "Registration occurred at {{#formatDate timestamp}}{{/formatDate}}\n\n#### Questions\n{{#each extraData.questions}}\n  **{{question}}**: {{answer}}\n{{/each}}",
  "tokens": [
    {
      "name": "petName",
      "type": "string",
      "createdAt": "2020-02-12T20:58:26Z",
      "updatedAt": "2020-02-12T20:58:26Z",
      "label": "Pet Name",
      "options": []
    },
    {
      "name": "petAge",
      "type": "number",
      "createdAt": "2020-02-12T20:58:26Z",
      "updatedAt": "2020-02-12T20:58:26Z",
      "label": "Pet Age",
      "options": []
    },
    {
      "name": "petColor",
      "type": "enumeration",
      "createdAt": "2020-02-12T20:58:26Z",
      "updatedAt": "2020-02-12T20:58:26Z",
      "label": "Pet Color",
      "options": [
        {
          "value": "white",
          "label": "White"
        },
        {
          "value": "black",
          "label": "Black"
        },
        {
          "value": "brown",
          "label": "Brown"
        },
        {
          "value": "other",
          "label": "Other"
        }
      ]
    }
  ]
}

テンプレート

Create an event template for your app

イベントテンプレートは、カスタムタイムラインイベントの全般的な構造を定め、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 'Content-Type: application/json' \
  --data '{
  "name": "PetSpot Registration",
  "objectType": "contacts",
  "headerTemplate": "Registered for [{{petName}}](https://my.petspot.com/pets/{{petName}})",
  "detailTemplate": "Registration occurred at {{#formatDate timestamp}}{{/formatDate}}\n\n#### Questions\n{{#each extraData.questions}}\n  **{{question}}**: {{answer}}\n{{/each}}",
  "tokens": [
    {
      "name": "petName",
      "label": "Pet Name",
      "type": "string"
    },
    {
      "name": "petAge",
      "label": "Pet Age",
      "type": "number"
    },
    {
      "name": "petColor",
      "label": "Pet Color",
      "type": "enumeration",
      "options": [
        {
          "value": "white",
          "label": "White"
        },
        {
          "value": "black",
          "label": "Black"
        },
        {
          "value": "brown",
          "label": "Brown"
        },
        {
          "value": "other",
          "label": "Other"
        }
      ]
    }
  ]
}'

{
  "id": "1001298",
  "objectType": "contacts",
  "createdAt": "2020-02-12T20:58:26Z",
  "updatedAt": "2020-02-12T20:58:26Z",
  "name": "PetSpot Registration",
  "headerTemplate": "Registered for [{{petName}}](https://my.petspot.com/pets/{{petName}})",
  "detailTemplate": "Registration occurred at {{#formatDate timestamp}}{{/formatDate}}\n\n#### Questions\n{{#each extraData.questions}}\n  **{{question}}**: {{answer}}\n{{/each}}",
  "tokens": [
    {
      "name": "petName",
      "type": "string",
      "createdAt": "2020-02-12T20:58:26Z",
      "updatedAt": "2020-02-12T20:58:26Z",
      "label": "Pet Name",
      "options": []
    },
    {
      "name": "petAge",
      "type": "number",
      "createdAt": "2020-02-12T20:58:26Z",
      "updatedAt": "2020-02-12T20:58:26Z",
      "label": "Pet Age",
      "options": []
    },
    {
      "name": "petColor",
      "type": "enumeration",
      "createdAt": "2020-02-12T20:58:26Z",
      "updatedAt": "2020-02-12T20:58:26Z",
      "label": "Pet Color",
      "options": [
        {
          "value": "white",
          "label": "White"
        },
        {
          "value": "black",
          "label": "Black"
        },
        {
          "value": "brown",
          "label": "Brown"
        },
        {
          "value": "other",
          "label": "Other"
        }
      ]
    }
  ]
}

サポートされる製品

次のいずれかの製品またはそれ以上が必要です。

Marketing Hub無料ツール

Sales Hub無料ツール

Service Hub無料ツール

Content HubStarter

Authorizations

hapikey

string

query

required

Path Parameters

appId

integer

required

ターゲットアプリのID。

Body

application/json

The new event template definition.

State of the template definition being created.

name

string

required

テンプレート名。

objectType

string

required

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

tokens

object[]

required

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

Anzeigen untergeordnete attribute

detailTemplate

string

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

headerTemplate

string

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

Response

successful operation

The current state of the template definition.

string

required

テンプレートID。

name

string

required

テンプレート名。

objectType

string

required

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

tokens

object[]

required

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

Anzeigen untergeordnete attribute

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になります。

Gets a specific event template for your app

Zurück

Update an existing event template

Weiter

⌘I

コール拡張機能

ビデオ会議拡張機能

タイムライン

Create an event template for your app

Authorizations

Path Parameters

Body

Response