Event types
View as MarkdownEvent types categorize events. Archiving a type keeps it available to historical records.
On this page
- The event type object
- List event typesGET
/api/v1/event-types - Retrieve an event typeGET
/api/v1/event-types/{id} - Create an event typePOST
/api/v1/event-types - Update an event typePATCH / PUT / POST
/api/v1/event-types/{id} - Delete an event typeDELETE
/api/v1/event-types/{id}POST/api/v1/event-types/{id}/delete
Event types categorize events. Archiving a type keeps it available to historical records.
Attributes
idinteger- Identifier assigned by the API.
namestringRequired- Name of the event type, up to 120 characters. Must be unique among active types.
sort_orderinteger- Display order.
archived_atinteger or null- Unix timestamp in seconds when archived.
/api/v1/event-typesLists event type records in the workspace.
Permissions
Send your API key in X-API-Key. Required permissions are Events → Read.
Query parameters
include_archivedboolean- Include archived event types. Defaults to false.
Returns
Returns types in display order, then by name.
Errors
401- The API key is missing or invalid.
403- The API key lacks the required permission.
/api/v1/event-types/{id}Returns one event type by ID.
Permissions
Send your API key in X-API-Key. Required permissions are Events → Read.
Path parameters
idintegerRequired- ID of the event type.
Returns
The event type is returned in data.
Errors
401- The API key is missing or invalid.
403- The API key lacks the required permission.
404- The requested record was not found.
/api/v1/event-typesCreates an event type.
Permissions
Send your API key in X-API-Key. Required permissions are Events → Write.
Body parameters
namestringRequired- Name of the event type, up to 120 characters. Must be unique among active types.
Returns
The created event type is returned in data.
Errors
401- The API key is missing or invalid.
403- The API key lacks the required permission.
400- The name is missing, invalid, or already used by an active event type.
/api/v1/event-types/{id}Updates an event type by ID.
Permissions
Send your API key in X-API-Key. Required permissions are Events → Write.
Path parameters
idintegerRequired- ID of the event type.
Body parameters
namestringRequired- Name of the event type, up to 120 characters. Must be unique among active types.
Returns
Returns a successful update response.
Errors
401- The API key is missing or invalid.
403- The API key lacks the required permission.
404- The requested record was not found.
400- The name is missing, invalid, or already used by an active event type.
/api/v1/event-types/{id}/api/v1/event-types/{id}/deleteArchives an event type. It remains retrievable by ID.
Permissions
Send your API key in X-API-Key. Required permissions are Events → Write.
Path parameters
idintegerRequired- ID of the event type.
Returns
Returns a successful removal response.
Errors
401- The API key is missing or invalid.
403- The API key lacks the required permission.
404- The requested record was not found.
400- The name is missing, invalid, or already used by an active event type.