"\nExample PUT URL, creating events for app ID 6543:\nhttps://api.hubapi.com/integrations/v1/6543/timeline/event\n\n\nExample JSON data:\n\nAn example with the minimum fields required to create a new event:\n{\n \"id\":\"3\",\n \"objectId\":1,\n \"eventTypeId\":\"123\"\n}\n\nYou can use the email or utk of a record in place of the contact vid,\nlike the following:\n{\n \"id\":\"3\",\n \"email\":\"test@test.com\",\n \"eventTypeId\":\"123\"\n}\n\n{\n \"id\":\"3\",\n \"utk\":\"89b5afb740d41f4cd6651ac5237edf09\",\n \"eventTypeId\":\"123\"\n}\n\nIf you provide an objectId and email, or the utk and email,\nthe email for the contact will be updated\nto the email that was passed with the event.\nThis example updates the email address of the contact with vid '11':\n{\n \"id\":\"1\",\n \"objectId\":11,\n \"email\":\"santa.claus@far.com\",\n \"eventTypeId\":\"123\"\n}\n\nEvent with some extra data (note that extra data is not\na string, it's part of the object sent in):\n{\n \"id\":\"3\",\n \"objectId\":1,\n \"eventTypeId\":\"123\",\n \"extraData\":{\n \"name\":\"JohnDoe\",\n \"weather\":\"Cloudy\"\n }\n}\n\nIf event type 123 has a numeric property called presentationId,\nthe following would also be a valid JSON to send for that\nevent type:\n{\n \"id\":\"3\",\n \"objectId\":1,\n \"eventTypeId\":\"123\",\n \"presentationId\":\"9876543\",\n \"extraData\":{\n \"name\":\"JohnDoe\",\n \"weather\":\"Cloudy\"\n }\n}\n\nNotice how, even though presentationId is a numeric property,\ndata has to come in as string.\n\nYou can include timelineIFrame to allow your event to \nshow an IFrame containing data from another system. \nThis example would include a link with the text 'View external data'\nthat when clicked would show a modal window contaning \nan IFrame for the page at 'https://www.example.com':\n{\n \"id\":\"3\",\n \"objectId\":1,\n \"eventTypeId\":\"123\",\n \"timelineIFrame\": {\n \"linkLabel\": \"View external data\",\n \"iframeLabel\": \"Example iframe\",\n \"iframeUri\": \"https://www.example.com\",\n \"width\": 800,\n \"height\": 300\n }\n}"
Create a new event, or update an existing event. Please see the Timeline Overview for more details about creating events. Events must include at least one identity parameter to be associated with a contact record. See the overview and the examples for more details.
"\nExample PUT URL, creating events for app ID 6543:\nhttps://api.hubapi.com/integrations/v1/6543/timeline/event\n\n\nExample JSON data:\n\nAn example with the minimum fields required to create a new event:\n{\n \"id\":\"3\",\n \"objectId\":1,\n \"eventTypeId\":\"123\"\n}\n\nYou can use the email or utk of a record in place of the contact vid,\nlike the following:\n{\n \"id\":\"3\",\n \"email\":\"test@test.com\",\n \"eventTypeId\":\"123\"\n}\n\n{\n \"id\":\"3\",\n \"utk\":\"89b5afb740d41f4cd6651ac5237edf09\",\n \"eventTypeId\":\"123\"\n}\n\nIf you provide an objectId and email, or the utk and email,\nthe email for the contact will be updated\nto the email that was passed with the event.\nThis example updates the email address of the contact with vid '11':\n{\n \"id\":\"1\",\n \"objectId\":11,\n \"email\":\"santa.claus@far.com\",\n \"eventTypeId\":\"123\"\n}\n\nEvent with some extra data (note that extra data is not\na string, it's part of the object sent in):\n{\n \"id\":\"3\",\n \"objectId\":1,\n \"eventTypeId\":\"123\",\n \"extraData\":{\n \"name\":\"JohnDoe\",\n \"weather\":\"Cloudy\"\n }\n}\n\nIf event type 123 has a numeric property called presentationId,\nthe following would also be a valid JSON to send for that\nevent type:\n{\n \"id\":\"3\",\n \"objectId\":1,\n \"eventTypeId\":\"123\",\n \"presentationId\":\"9876543\",\n \"extraData\":{\n \"name\":\"JohnDoe\",\n \"weather\":\"Cloudy\"\n }\n}\n\nNotice how, even though presentationId is a numeric property,\ndata has to come in as string.\n\nYou can include timelineIFrame to allow your event to \nshow an IFrame containing data from another system. \nThis example would include a link with the text 'View external data'\nthat when clicked would show a modal window contaning \nan IFrame for the page at 'https://www.example.com':\n{\n \"id\":\"3\",\n \"objectId\":1,\n \"eventTypeId\":\"123\",\n \"timelineIFrame\": {\n \"linkLabel\": \"View external data\",\n \"iframeLabel\": \"Example iframe\",\n \"iframeUri\": \"https://www.example.com\",\n \"width\": 800,\n \"height\": 300\n }\n}"
Successful response - Create a new event, or update an existing event
The response is of type object
.
Was this page helpful?