Events
Was this helpful?
Was this helpful?
Data elements representing an event from an integration.
List all the event categories in the workspace. Optional filter by title.
Filter event categories by title
Landing PageWarning: 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.
Filter by integration ID
cf103b4785764467ad34384cd523abd9Filter by parent ID
43d7c33dad744dfbbfadc172f6701afbFilter by title
ClickedWarning: 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.
The ID of the event to retrieve.
226dc8aafa8d46468b116652cdc64065Retrieve a list of events with optional filtering using the integration_id, parent_id (the event), and title.
Filter by integration ID
cf103b4785764467ad34384cd523abd9Filter by parent ID
43d7c33dad744dfbbfadc172f6701afbFilter by title
trueUse this endpoint to create a new event category. This will be the parent of events. The category must be associated to an integration.
The name of the category.
Landing PageThe UUID of the associated integration.
The teams the category belongs to.
["e8ac09ede51e4e618eaf59942c98c260"]Use this endpoint to partially update event metadata.
The ID of the event to update.
226dc8aafa8d46468b116652cdc64065A description of the resource.
This is a description for a sample table.Mark down documentation to be added to the resource.
\n# Castae illa\n\n## Finemque aequore\n\nLorem markdownum motusIndicates whether the resource contains personally identifiable information (PII). Values can be - True False
falseIndicates whether the table has been set as verified. Values can be - True False
trueIndicates if the resource is visible to viewers or not. Values can be - True False
trueA list of team IDs that the resource belongs to.
["e8ac09ed-e51e-4e61-8eaf-59942c98c260","cca810f1-11c1-4117-bc23-20ae8020897f"]A list of owner user IDs for the resource.
["33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]A list of collection IDs the resource belongs to.
["3b2c7185-fb5d-4d94-89d4-3dae08e093a9"]A list of tag IDs associated with the resources.
["04654d61-4f64-4f08-b697-3915b5137c49","429693a2-a5e7-4525-b413-ece5e96bc5b3"]A list of the added user IDs that have been subscribed to the resource. Anyone subscribed will be notified of any changes.
["c90dedee-40ee-47ec-9c27-96dc3b2ec363"]Create a new event property with the provided data. Event properties must have an Event as a parent, and be associated with an integration.
The type of property associated with the event. Examples include string, enum, integer, etc.
enumIf the property type is enum, this field indicates the various enum values.
red, green, yellowSet this to true if the property is required.
Use this endpoint to partially update event metadata.
The ID of the event property to update.
226dc8aafa8d46468b116652cdc64065A description of the resource.
This is a description for a sample table.Mark down documentation to be added to the resource.
\n# Castae illa\n\n## Finemque aequore\n\nLorem markdownum motusIndicates whether the resource contains personally identifiable information (PII). Values can be - True False
falseIndicates whether the table has been set as verified. Values can be - True False
trueIndicates if the resource is visible to viewers or not. Values can be - True False
trueA list of team IDs that the resource belongs to.
["e8ac09ed-e51e-4e61-8eaf-59942c98c260","cca810f1-11c1-4117-bc23-20ae8020897f"]A list of owner user IDs for the resource.
["33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]A list of collection IDs the resource belongs to.
["3b2c7185-fb5d-4d94-89d4-3dae08e093a9"]A list of tag IDs associated with the resources.
["04654d61-4f64-4f08-b697-3915b5137c49","429693a2-a5e7-4525-b413-ece5e96bc5b3"]A list of the added user IDs that have been subscribed to the resource. Anyone subscribed will be notified of any changes.
["c90dedee-40ee-47ec-9c27-96dc3b2ec363"]