> ## Documentation Index > Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt > Use this file to discover all available pages before exploring further. --- id: f2c50ec2-f64a-42fd-98d2-463812746cfe --- # Create an event template > Event templates define the general structure for a custom timeline event, and enable you to send event data to HubSpot. A template includes formatted copy for its heading and details, as well as any custom property definitions. A single app can include up to 750 event templates.
the `v1` and `v3` timeline events APIs are only available for app partners with existing `v1`/`v3` timeline events defined in their public app. If you're not an app partner, you can send custom event data to HubSpot using the [custom events API](/api-reference/events-manage-event-definitions-v3/guide). export const SupportedProducts = ({marketing, sales, service, cms, data, commerce, marketingLevel, salesLevel, serviceLevel, cmsLevel, dataLevel, commerceLevel}) => { const translations = { description: "Requires one of the following products or higher.", productNames: { marketing: "Marketing Hub", sales: "Sales Hub", service: "Service Hub", cms: "Content Hub", data: "Data Hub", commerce: "Revenue Hub" }, tiers: { free: "Free", starter: "Starter", professional: "Professional", enterprise: "Enterprise" } }; const translateTier = tier => { if (!tier) return ''; const lowerTier = tier.toLowerCase(); return translations.tiers[lowerTier] || tier; }; const products = [{ name: marketing ? translations.productNames.marketing : '', level: translateTier(marketingLevel), icon: "https://mintlify-assets.b-cdn.net/Icons/marketing-bolt.svg", alt: "Marketing Hub" }, { name: sales ? translations.productNames.sales : '', level: translateTier(salesLevel), icon: "https://mintlify-assets.b-cdn.net/Icons/sales-star.svg", alt: "Sales Hub" }, { name: service ? translations.productNames.service : '', level: translateTier(serviceLevel), icon: "https://mintlify-assets.b-cdn.net/Icons/service-heart.svg", alt: "Service Hub" }, { name: cms ? translations.productNames.cms : '', level: translateTier(cmsLevel), icon: "https://mintlify-assets.b-cdn.net/Icons/content-play.svg", alt: "Content Hub" }, { name: data ? translations.productNames.data : '', level: translateTier(dataLevel), icon: "https://developers.hubspot.com/hubfs/Knowledge_Base_2023-24-25/subscription_key_icons/operations_icon.svg", alt: "Data Hub" }, { name: commerce ? translations.productNames.commerce : '', level: translateTier(commerceLevel), icon: "https://developers.hubspot.com/hubfs/Knowledge_Base/subscription_key_icons/commerce_icon.svg", alt: "Revenue Hub" }].filter(product => product.name && product.level); if (products.length === 0) return null; return
{translations.description}
{products.map((product, index) =>
{product.alt} {product.name} - {product.level}
)}
; }; ## OpenAPI ````yaml specs/legacy/v3/crm-timeline-v3.json POST /integrators/timeline/v3/{appId}/event-templates openapi: 3.0.1 info: title: Timeline description: Basepom for all HubSpot Projects version: v3 x-hubspot-product-tier-requirements: marketing: FREE sales: FREE service: FREE cms: FREE commerce: FREE crmHub: FREE dataHub: FREE x-hubspot-api-use-case: >- After setting up a new set of sign-up flows on your website, update contact timelines to indicate which flow they completed. In each event, you could also include a link to open an iframe that displays additional external data about the event. x-hubspot-related-documentation: - name: Timeline Events Guide url: https://developers.hubspot.com/docs/guides/api/crm/extensions/timeline x-hubspot-introduction: >- Use the timeline events API to add custom event information to CRM record timelines. You'll first need to create a public app, then an event template to display event data. servers: - url: https://api.hubapi.com security: [] tags: - name: Advanced - name: Basic - name: Batch paths: /integrators/timeline/v3/{appId}/event-templates: post: tags: - Basic summary: Create an event template description: >- Event templates define the general structure for a custom timeline event, and enable you to send event data to HubSpot. A template includes formatted copy for its heading and details, as well as any custom property definitions. A single app can include up to 750 event templates.
the `v1` and `v3` timeline events APIs are only available for app partners with existing `v1`/`v3` timeline events defined in their public app. If you're not an app partner, you can send custom event data to HubSpot using the [custom events API](/api-reference/events-manage-event-definitions-v3/guide). operationId: post-/integrators/timeline/v3/{appId}/event-templates_create parameters: - name: appId in: path description: '' required: true style: simple explode: false schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/TimelineEventTemplateCreateRequest' required: true responses: '201': description: successful operation headers: Location: description: URL of the newly created resource style: simple explode: false schema: type: string content: application/json: schema: $ref: '#/components/schemas/TimelineEventTemplate' default: $ref: '#/components/responses/Error' description: '' deprecated: true security: - oauth2: - developers-write components: schemas: TimelineEventTemplateCreateRequest: required: - name - objectType - tokens type: object properties: detailTemplate: type: string description: >- This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline when you expand the details. headerTemplate: type: string description: >- This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline as a header. name: type: string description: The template name. objectType: type: string description: >- The type of CRM object this template is for. [Contacts, companies, tickets, and deals] are supported. tokens: type: array description: >- A collection of tokens that can be used as custom properties on the event and to create fully fledged CRM objects. items: $ref: '#/components/schemas/TimelineEventTemplateToken' TimelineEventTemplate: required: - id - name - objectType - tokens type: object properties: createdAt: type: string description: >- The date and time that the Event Template was created, as an ISO 8601 timestamp. Will be null if the template was created before Feb 18th, 2020. format: date-time detailTemplate: type: string description: >- This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline when you expand the details. headerTemplate: type: string description: >- This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline as a header. id: type: string description: The template ID. name: type: string description: The template name. objectType: type: string description: >- The type of CRM object this template is for. [Contacts, companies, tickets, and deals] are supported. tokens: type: array description: >- A collection of tokens that can be used as custom properties on the event and to create fully fledged CRM objects. items: $ref: '#/components/schemas/TimelineEventTemplateToken' updatedAt: type: string description: >- The date and time that the Event Template was last updated, as an ISO 8601 timestamp. Will be null if the template was created before Feb 18th, 2020. format: date-time TimelineEventTemplateToken: required: - label - name - options - type type: object properties: createdAt: type: string description: >- The date and time that the Event Template Token was created, as an ISO 8601 timestamp. Will be null if the template was created before Feb 18th, 2020. format: date-time label: type: string description: Used for list segmentation and reporting. name: type: string description: >- The name of the token referenced in the templates. This must be unique for the specific template. It may only contain alphanumeric characters, periods, dashes, or underscores (. - _). objectPropertyName: type: string description: >- The name of the CRM object property. This will populate the CRM object property associated with the event. With enough of these, you can fully build CRM objects via the Timeline API. options: type: array description: >- If type is `enumeration`, we should have a list of options to choose from. items: $ref: '#/components/schemas/TimelineEventTemplateTokenOption' type: type: string description: >- The data type of the token. You can currently choose from [string, number, date, enumeration]. enum: - date - enumeration - number - string updatedAt: type: string description: >- The date and time that the Event Template Token was last updated, as an ISO 8601 timestamp. Will be null if the template was created before Feb 18th, 2020. format: date-time Error: required: - category - correlationId - message type: object properties: category: type: string description: The error category context: type: object additionalProperties: type: array items: type: string description: Context about the error condition example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- A unique identifier for the request. Include this value with any error reports or support tickets format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: further information about the error items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: >- A map of link names to associated URIs containing documentation about the error or recommended remediation steps message: type: string description: >- A human readable message describing the error along with remediation steps where appropriate example: An error occurred subCategory: type: string description: >- A specific category that contains more specific detail about the error example: 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 TimelineEventTemplateTokenOption: required: - label - value type: object properties: label: type: string description: The label of the option that is displayed in the front end. value: type: string description: The value of the option that is provided on the occurrence. ErrorDetail: required: - message type: object properties: code: type: string description: The status code associated with the error detail context: type: object additionalProperties: type: array items: type: string description: Context about the error condition example: '{missingScopes=[scope1, scope2]}' in: type: string description: The name of the field or parameter in which the error was found. message: type: string description: >- A human readable message describing the error along with remediation steps where appropriate subCategory: type: string description: >- A specific category that contains more specific detail about the error responses: Error: description: An error occurred. content: '*/*': schema: $ref: '#/components/schemas/Error' securitySchemes: oauth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://app.hubspot.com/oauth/authorize tokenUrl: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.companies.highly_sensitive.read.v2: '' crm.objects.companies.highly_sensitive.write.v2: '' crm.objects.companies.read: '' crm.objects.companies.sensitive.read.v2: '' crm.objects.companies.sensitive.write.v2: '' crm.objects.companies.write: '' crm.objects.contacts.highly_sensitive.read.v2: '' crm.objects.contacts.highly_sensitive.write.v2: '' crm.objects.contacts.read: '' crm.objects.contacts.sensitive.read.v2: '' crm.objects.contacts.sensitive.write.v2: '' crm.objects.contacts.write: '' crm.objects.deals.highly_sensitive.read.v2: '' crm.objects.deals.highly_sensitive.write.v2: '' crm.objects.deals.read: '' crm.objects.deals.sensitive.read.v2: '' crm.objects.deals.sensitive.write.v2: '' crm.objects.deals.write: '' crm.schemas.companies.read: '' crm.schemas.companies.write: '' crm.schemas.contacts.read: '' crm.schemas.contacts.write: '' crm.schemas.deals.read: '' crm.schemas.deals.write: '' developers-read: '' developers-write: '' tickets: '' tickets.highly_sensitive.v2: '' tickets.sensitive.v2: '' timeline: '' timeline.read: '' timeline.write: '' ````