Sign in

v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
Custom Events

Retrieve an event definition

Retrieves a custom event definition you previously created.

get/event/definitions/{name}

Path parameters

namestring required
Example:unique_event_name

Name of the custom event.

Response

Successfully retrieved the event definition.

namestring

The name of the custom event definition.

labelstring

The label of the event definition, used for display purposes.

descriptionstring

The description of the event definition.

objectType'CONTACT'

Type of the object that the event will be associated with.

  • CONTACT: Indicates that the object is a contact.
createTimestring date-time

The time at which this object is created, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z.

Example response

{
  "name": "propertyName",
  "label": "Property Label",
  "description": "Describes this property",
  "objectType": "CONTACT",
  "createTime": "2024-08-22T00:00:00.000Z",
  "properties": [
    {
      "name": "propertyName",
      "label": "Property Label",
      "description": "Describes this property",
      "createTime": "2024-08-22T00:00:00.000Z"
    }
  ]
}