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 group of timeline events

Last updated May 6, 2024

POST /integrations/v1/:application‐id/timeline/event/batch

Please note: beginning December 2024, the following changes will be made to the v1 Integration Timeline API.

  • You will not be able to update existing events.
  • You cannot use the PUT method to create events.

You can now use the POST method to create events, however it's recommended to transition to the v3 Timeline Events API for the most up to date features. Learn more about this update on the HubSpot Developer Changelog.

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

N/A

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

timeline

Create or update a group of timeline events. This can be used to backfill events when your integration is first installed, or to efficiently sync a large number of events occurring over a short period of time. Up to 100 events can be included in a single batch.

See the Timeline Overview for more details about creating and working with events.

See creating or updating a single event for more details about the data that should be included for each event.

Required Parameters How to use Description
OAuth Access Token Authorization: Bearer {token}
Used in the request headers		 Used to authenticate the request. Please see this page for more details about authentication.
NOTE: You must use an OAuth access token to create an event. API keys are not supported.
application-id Used in the request URL The ID of the application that the event type was created for. The eventTypeId used in the request body must line up with this application-id.
Events list "eventWrappers": []
Used in the request body		 A list of events that you want to create or update. See creating or updating an event for more details on the format used for events.
Up to 100 events can be included in a single batch.

Returns a 204 No Content response on success.Otherwise, you'll receive a 4xx error, with more details about the specific error in the body of the response.

Note: if there are any problems with the request, the entire batch will fail, so a 4xx response means that no events will be created or updated.

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
This example creates two events, one for the existing contact with vid '27', and the other for the contact with the email address 'test@test.com' (creating a contact with that email if none exists). The events are type '123' for app ID '6543' Example PUT URL: https://api.hubapi.com/integrations/v1/6543/timeline/event/batch Example JSON data: { "eventWrappers": [ { "id": "789", "objectId": 27, "eventTypeId": "123", "timestamp": "1491062400000" }, { "id": "790", "email":"test@test.com", "eventTypeId": "123", "timeprop": "1491105600000", "extraData": { "name": "JohnDoe", "weather": "Cloudy" } } ] }
import requests import json OauthToken = 'XXXXX' url = 'https://api.hubapi.com/integrations/v1/:application-id/timeline/event/batch' headers = {} headers['Content-Type'] = 'application/json' headers['Authorization'] = 'Bearer'+' '+OauthToken data ={ "eventWrappers": [ { "id":123, "objectId": 116351, "eventTypeId": "386927", "timestamp": "1491062400000" }, { "id": 1234, "objectId": 116101, "eventTypeId": "386927", "extraData": { "name": "JohnDoe", "weather": "Cloudy" } } ] } put_data = json.dumps(data) r = requests.put( data = put_data, url = url, headers = headers) print(r.status_code)