Start free trial

Events

Data elements representing an event from an integration.

List Event Categories

get
/api/v1/event/category

List all the event categories in the workspace. Optional filter by title.

Authorizations
Query parameters
titlestringOptional

Filter event categories by title

Example: Landing Page
Responses
200

List of event categories.

application/json
get
/api/v1/event/category

Create Event Category

post
/api/v1/event/category

Use this endpoint to create a new event category. This will be the parent of events. The category must be associated to an integration.

Authorizations
Body
titlestringOptional

The name of the category.

Example: Landing Page
integrationstringOptional

The UUID of the associated integration.

teamsstring[]Optional

The teams the category belongs to.

Example: ["e8ac09ede51e4e618eaf59942c98c260"]
Responses
post
/api/v1/event/category

Get Event Category by Id

get
/api/v1/event/category/{event_category_id}

Retrieve the information of a specific event category.

Authorizations
Path parameters
event_category_idstringRequired

ID of the event category to retrieve

Example: 43d7c33dad744dfbbfadc172f6701afb
Responses
200

OK

application/json
get
/api/v1/event/category/{event_category_id}
Deprecated

List Events

get
/api/v1/event/events

Warning: This endpoint is deprecated. Please use the List Resources endpoint instead with filter={"operator":"exact","field":"type","value":"event"}.

Retrieve a list of events with optional filtering using the integration_id, parent_id (the event category), and title.

Authorizations
Query parameters
integration_idstringOptional

Filter by integration ID

Example: cf103b4785764467ad34384cd523abd9
parent_idstringOptional

Filter by parent ID

Example: 43d7c33dad744dfbbfadc172f6701afb
titlestringOptional

Filter by title

Example: Clicked
Responses
200

List of events.

application/json
get
/api/v1/event/events

Create Event

post
/api/v1/event/events

Create a new event with the provided data. Events must have a Category as a parent, and be associated with an integration.

Authorizations
Body
Responses
post
/api/v1/event/events
Deprecated

Get Event

get
/api/v1/event/events/{event_id}

Warning: This endpoint is deprecated. Please use the List Resources endpoint instead with filter={"operator":"exact","field":"id","value":"your-event-id"}.

Retrieve a specific event by its ID.

Authorizations
Path parameters
event_idstringRequired

The ID of the event to retrieve.

Example: 226dc8aafa8d46468b116652cdc64065
Responses
200

OK

application/json
get
/api/v1/event/events/{event_id}

Delete Event

delete
/api/v1/event/events/{event_id}

Delete a specific event by it's ID.

Authorizations
Path parameters
event_idstringRequired

The ID of the event to delete.

Responses
200

OK

application/json
delete
/api/v1/event/events/{event_id}

Update an Event

patch
/api/v1/event/events/{event_id}

Use this endpoint to partially update event metadata.

Authorizations
Path parameters
event_idstringRequired

The ID of the event to update.

Example: 226dc8aafa8d46468b116652cdc64065
Body
descriptionstringOptional

A description of the resource.

Example: This is a description for a sample table.
definitionstringOptional

Mark down documentation to be added to the resource.

Example: \n# Castae illa\n\n## Finemque aequore\n\nLorem markdownum motus
piibooleanOptional

Indicates whether the resource contains personally identifiable information (PII). Values can be - True False

Example: false
verifiedbooleanOptional

Indicates whether the table has been set as verified. Values can be - True False

Example: true
publishedbooleanOptional

Indicates if the resource is visible to viewers or not. Values can be - True False

Example: true
teamsstring[]Optional

A list of team IDs that the resource belongs to.

Example: ["e8ac09ed-e51e-4e61-8eaf-59942c98c260","cca810f1-11c1-4117-bc23-20ae8020897f"]
ownersstring[]Optional

A list of owner user IDs for the resource.

Example: ["33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]
collectionsstring[]Optional

A list of collection IDs the resource belongs to.

Example: ["3b2c7185-fb5d-4d94-89d4-3dae08e093a9"]
tagsstring[]Optional

A list of tag IDs associated with the resources.

Example: ["04654d61-4f64-4f08-b697-3915b5137c49","429693a2-a5e7-4525-b413-ece5e96bc5b3"]
subscribersstring[]Optional

A list of the added user IDs that have been subscribed to the resource. Anyone subscribed will be notified of any changes.

Example: ["c90dedee-40ee-47ec-9c27-96dc3b2ec363"]
Responses
200

OK

application/json
patch
/api/v1/event/events/{event_id}

List Event Properties

get
/api/v1/event/event_properties

Retrieve a list of events with optional filtering using the integration_id, parent_id (the event), and title.

Authorizations
Query parameters
integration_idstringOptional

Filter by integration ID

Example: cf103b4785764467ad34384cd523abd9
parent_idstringOptional

Filter by parent ID

Example: 43d7c33dad744dfbbfadc172f6701afb
titlestringOptional

Filter by title

Example: true
Responses
200

List of event properties.

application/json
get
/api/v1/event/event_properties

Create Event Property

post
/api/v1/event/event_properties

Create a new event property with the provided data. Event properties must have an Event as a parent, and be associated with an integration.

Authorizations
Body
Responses
200

Event property created.

application/json
post
/api/v1/event/event_properties

Get Event Property

get
/api/v1/event/event_properties/{event_property_id}

Retrieve a specific event property by its ID.

Authorizations
Path parameters
event_property_idstringRequired

The ID of the event property to retrieve.

Example: 226dc8aafa8d46468b116652cdc64065
Responses
200

OK

application/json
get
/api/v1/event/event_properties/{event_property_id}

Delete Event Property

delete
/api/v1/event/event_properties/{event_property_id}

Delete a specific event property by it's ID.

Authorizations
Path parameters
event_property_idstringRequired

The ID of the event property to delete.

Responses
200

OK

application/json
delete
/api/v1/event/event_properties/{event_property_id}

Update an Event Property

patch
/api/v1/event/event_properties/{event_property_id}

Use this endpoint to partially update event metadata.

Authorizations
Path parameters
event_property_idstringRequired

The ID of the event property to update.

Example: 226dc8aafa8d46468b116652cdc64065
Body
descriptionstringOptional

A description of the resource.

Example: This is a description for a sample table.
definitionstringOptional

Mark down documentation to be added to the resource.

Example: \n# Castae illa\n\n## Finemque aequore\n\nLorem markdownum motus
piibooleanOptional

Indicates whether the resource contains personally identifiable information (PII). Values can be - True False

Example: false
verifiedbooleanOptional

Indicates whether the table has been set as verified. Values can be - True False

Example: true
publishedbooleanOptional

Indicates if the resource is visible to viewers or not. Values can be - True False

Example: true
teamsstring[]Optional

A list of team IDs that the resource belongs to.

Example: ["e8ac09ed-e51e-4e61-8eaf-59942c98c260","cca810f1-11c1-4117-bc23-20ae8020897f"]
ownersstring[]Optional

A list of owner user IDs for the resource.

Example: ["33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]
collectionsstring[]Optional

A list of collection IDs the resource belongs to.

Example: ["3b2c7185-fb5d-4d94-89d4-3dae08e093a9"]
tagsstring[]Optional

A list of tag IDs associated with the resources.

Example: ["04654d61-4f64-4f08-b697-3915b5137c49","429693a2-a5e7-4525-b413-ece5e96bc5b3"]
subscribersstring[]Optional

A list of the added user IDs that have been subscribed to the resource. Anyone subscribed will be notified of any changes.

Example: ["c90dedee-40ee-47ec-9c27-96dc3b2ec363"]
Responses
200

OK

application/json
patch
/api/v1/event/event_properties/{event_property_id}

Last updated

Was this helpful?