v2
latestOpenAPI 3.1.02026-07-312303692.4 MBEvent Type
List Event Types
Return the list of event types.
get/api/v1/event-type
Query parameters
limitinteger
Limit the number of returned items
Limit the number of returned items
iteratorstring nullable
The iterator returned from a prior invocation
Example:user.signup
The iterator returned from a prior invocation
order'ascending' | 'descending'
Defines the ordering in a listing of results.
The sorting order of the returned items
include_archivedboolean
When true archived (deleted but not expunged) items are included in the response.
When true archived (deleted but not expunged) items are included in the response.
with_contentboolean
When true the full item (including the schema) is included in the response.
When true the full item (including the schema) is included in the response.
Response
Example response
{
"data": [
{
"name": "user.signup",
"description": "A user has signed up",
"schemas": {
"1": {
"title": "Invoice Paid Event",
"description": "An invoice was paid by a user",
"type": "object",
"properties": {
"invoiceId": {
"description": "The invoice id",
"type": "string"
},
"userId": {
"description": "The user id",
"type": "string"
}
},
"required": [
"invoiceId",
"userId"
]
}
},
"groupName": "user",
"featureFlags": [
"cool-new-feature"
]
}
],
"iterator": "iterator",
"prevIterator": "-iterator"
}