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>"
}
'import requests
url = "https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates"
payload = {
"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>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
})
};
fetch('https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"objectType\": \"<string>\",\n \"tokens\": [\n {\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"objectPropertyName\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"detailTemplate\": \"<string>\",\n \"headerTemplate\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"objectType\": \"<string>\",\n \"tokens\": [\n {\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"objectPropertyName\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"detailTemplate\": \"<string>\",\n \"headerTemplate\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"objectType\": \"<string>\",\n \"tokens\": [\n {\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"objectPropertyName\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"detailTemplate\": \"<string>\",\n \"headerTemplate\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"message": "Invalid input (details will vary based on the error)",
"correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
"category": "VALIDATION_ERROR",
"links": {
"knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
}
}Create an event template
イベントテンプレートは、カスタムタイムラインイベントの全般的な構造を定め、HubSpotにイベントデータを送信可能にします。テンプレートには、カスタムプロパティーの定義以外にも、書式設定された見出しと詳細のコピーが含まれます。1つのアプリに含めることができるイベントテンプレートは最大750件です。
- アプリにまだタイムラインイベントが含まれていない場合、このエンドポイントへのリクエストは失敗します。代わりに、開発者プラットフォームの最新バージョンで始めることができます。承認を申請する前に、アプリのアプリイベントを定義する必要があることに注意してください。詳しくは、アプリイベントの概要をご確認ください。
- アプリに「v1」/「v3」タイムラインイベントが含まれている場合は、開発者プラットフォームに移行する方法をご確認ください。既存のイベントタイプを移行する前に承認を申請する必要はありません。
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>"
}
'import requests
url = "https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates"
payload = {
"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>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
})
};
fetch('https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"objectType\": \"<string>\",\n \"tokens\": [\n {\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"objectPropertyName\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"detailTemplate\": \"<string>\",\n \"headerTemplate\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"objectType\": \"<string>\",\n \"tokens\": [\n {\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"objectPropertyName\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"detailTemplate\": \"<string>\",\n \"headerTemplate\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"objectType\": \"<string>\",\n \"tokens\": [\n {\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"objectPropertyName\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"detailTemplate\": \"<string>\",\n \"headerTemplate\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"message": "Invalid input (details will vary based on the error)",
"correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
"category": "VALIDATION_ERROR",
"links": {
"knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
}
}Supported products
Supported products
承認
The access token received from the authorization server in the OAuth 2.0 flow.
パスパラメータ
ボディ
テンプレート名。
このテンプレートが[コンタクト、会社、チケット、取引]についてサポートされているCRMオブジェクトのタイプ。
イベントのカスタムプロパティーとして使用でき、完全なCRMオブジェクトを作成するためのトークンのコレクション。
Show child attributes
Show child attributes
詳細を展開すると、Handlebarsとイベント固有のデータを含めてMarkdown構文を使用してタイムラインでHTMLがレンダリングされます。
ヘッダーとして、Handlebarsとイベント固有のデータを含めてMarkdown構文を使用してタイムラインでHTMLがレンダリングされます。
レスポンス
successful operation
テンプレートID。
テンプレート名。
このテンプレートが[コンタクト、会社、チケット、取引]についてサポートされているCRMオブジェクトのタイプ。
イベントのカスタムプロパティーとして使用でき、完全なCRMオブジェクトを作成するためのトークンのコレクション。
Show child attributes
Show child attributes
イベントテンプレートが作成された日時(ISO 8601タイムスタンプ)。テンプレートが2020年2月18日より前に作成された場合はnullになります。
詳細を展開すると、Handlebarsとイベント固有のデータを含めてMarkdown構文を使用してタイムラインでHTMLがレンダリングされます。
ヘッダーとして、Handlebarsとイベント固有のデータを含めてMarkdown構文を使用してタイムラインでHTMLがレンダリングされます。
イベントテンプレートが最後に更新された日時(ISO 8601タイムスタンプ)。テンプレートが2020年2月18日より前に作成された場合はnullになります。