Event Type
List Event Types
Changed onReturn the list of event types.
get/api/v1/event-type
Request
- Base URLhttps://api.eu.svix.com
- URLhttps://api.eu.svix.com/api/v1/event-type
- AuthHTTP bearer
Query parameters
limitinteger
Limit the number of returned items
iteratorstring nullable
The iterator returned from a prior invocation
Example:user.signup
order'ascending' | 'descending'
Defines the ordering in a listing of results.
The sorting order of the returned items
include_archivedboolean
Include archived items in the response.
Deprecated, use archive_status instead. Ignored when archive_status is set.
archive_status'active' | 'archived' | 'all'
Which items to include based on whether they are archived.
Defaults to active.
with_contentboolean
When true the full item (including the schema) is included in the response.
Response
Example response
{
"data": [
{
"description": "A user has signed up",
"descriptionTranslations": {
"en": "A user has signed up",
"es": "Un usuario se ha registrado",
"pt-BR": "Um usuário se cadastrou"
},
"featureFlags": [
"cool-new-feature"
],
"groupName": "user",
"name": "user.signup",
"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"
]
}
}
}
],
"iterator": "iterator",
"prevIterator": "-iterator"
}Changes
- info
added the new optional
queryrequest parameterarchive_status
- info
- info
added the optional property
//to the response with the status - info
added the required property
to the response with the status
- info