Get Properties for Timeline Event Type

GET /integrations/v1/:application-id/timeline/event-types/:event-type-id/properties

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Developer Tools

Get the custom properties for a specified event type.

In addition to the default properties that all events have, you can also create custom properties for your event types. These custom properties give more specific information about the event. For example:

  • You have an event type for a lead opening a presentation. The custom properties for this event type could be the presentation ID and the last slide opened.
  • You have an event type for watching a vídeo. The custom properties for the event type could be the video ID and minutes watched.
Required Parameters How to use Description
hapikey= Used in the request URL  Your Developer HAPIkey. This must be a Developer HAPIkey associated with the Developer portal that the OAuth app was created in.
application-id Used in the request URL The ID of the application that the event type belongs to
event-type-id Used in the request URL The ID of the event type that you want to get the properties for. 

Optional ParametersHow to useDescription
None None No optional parameters for this method.

Each property will have the following fields:

  • id: The Generated identifier for this property
  • name: A string that identifies this property. This will be used to set the property in the event. Needs to follow the rules for identifiers from the JSON documentation.
  • propertyType: Specifies the type of information that will be hold on this property. When submitting an event, values should always come in as strings but will be validated against this type. This value will be one of the following: Date, Enumeration, Numeric or String.
  • label: Used when showing this property on user interfaces.
  • eventTypeId: The event type that this property belongs to.
  • options: An array with all the possible options that the specific property accepts. It only makes sense for Enumerationproperties. When GETting a property, you'll get the options for it or an empty array. When PUTting or POSTing, if options is provided, it will be used to update all options for the property. If it is not provided or it's null, it will be ignored. Important!! If it's set to an empty array, it will delete all options for the property.
  • objectProperty: The name of a property from the objectType set for the event type. (i.e. if the event type has an objectType of CONTACT, then this should be set to a contact property).  If you want a property in the object to be updated when you post an event, you can set the object property name here and we'll take care of that for you (i.e. if objectType is CONTACT, and objectProperty is jobtitle, we'll update the job title of the contact record).