There's a new version of the HubSpot API

Check out the new API
View Beta Docs

We're also working on a new documentation website, you're invited to check it out and give us your feedback.

Create a new Timeline Event Type

Last updated June 17, 2020

POST /integrations/v1/:application-id/timeline/event-types

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Developer Tools

Required Scope:

timeline

Create a new event type. The event type should represent an action that can take place in your platform, and act as the template for individual events. You must create an event type before you can create individual events.

By default, event types are created for contacts, but it's possible to create event types for companies or deals using the objectType field.

Note: Event properties cannot be named log or lookup. These tokens are reserved as helpers by the library used to render events in-app, Handlebars.js. For more information, check out the Handlebars.js docs here.

Required Parameters How to use Description
hapikey= Used in the request URL Your developer API key.  This must be the developer API key associated with the developer account that the OAuth app was created in.
userId= Used in the request URL Your HubSpot user ID. This can be found in the same place as your developer API key in your developer account.
application-id  Used in the request URL The ID of the OAuth app you're creating the event type for.
 name Used in the request JSON body The name of the event type. 
applicationId Used in the request JSON body The ID of the OAuth app you're creating the event type for. Note: The applicationId used in the body must match the application-id used in the URL.

Optional Parameters How to use Description
headerTemplate Used in the request JSON body

The header template, used when displaying the event in the timeline. 
detailTemplate Used in the request JSON body The detail template, used when displaying the details of the event in the timeline.
objectType Used in the request JSON body The type of object (CONTACT, COMPANY, or DEAL) this event corresponds to. Defaults to CONTACT.

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example POST URL: https://api.hubapi.com/integrations/v1/123/timeline/event-types?hapikey=xxxx-xxxx-xxxx-xxxx&userId=123456 Example JSON to create a new event type, with header and detail templates: { "name":"New Event Type", "applicationId":"123", "objectType":"CONTACT", "headerTemplate":"# Title for event {{id}}\nThis is an event for {{objectType}}", "detailTemplate":"This event happened on {{#formatDate timestamp}}{{/formatDate}}" } The response will contain all fields plus the generated ID. Example for this response would be: { "id":261, "name":"Test Event Type", "headerTemplate":"# Title for event {{id}}\nThis is an event for {{objectType}}", "detailTemplate":"This event happened on {{#formatDate timestamp}}{{/formatDate}}", "applicationId":123, "objectType": "CONTACT" }
import requests import json url = 'https://api.hubapi.com/integrations/v1/:application-id/timeline/event-types?hapikey=XXXX&userId=XXXX' headers={} headers['Content-Type']='application/json' data ={ "name": "New Event Type", "applicationId":"XXXX", "objectType":"CONTACT", "headerTemplate": "sample header template", "detailTemplate":"sample detail template" } put_data = json.dumps(data) r = requests.post( data = put_data, url = url, headers = headers) print(r.status_code)