Sign in

v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
Custom Events

Create an event definition

Creates a custom event definition.

post/event/definitions

Request body

namestring required

The unique name of the custom event.

labelstring required

The label of the custom event.

descriptionstring

The description of the event.

objectType'CONTACT' required

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

  • CONTACT: Indicates that the object is a contact.

Example request

{
  "name": "unique_event_name",
  "label": "My event label",
  "description": "Describes this event",
  "objectType": "CONTACT",
  "properties": [
    {
      "name": "unique_property_name",
      "label": "Property Label",
      "description": "Describes this property",
      "type": "STRING"
    }
  ]
}

Response

Successfully created an 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"
    }
  ]
}