Skip to main content
GET
/
v2
/
notifications
/
schemas
/
{event_name}
Get Event Schema
curl --request GET \
  --url https://api.catenatelematics.com/v2/notifications/schemas/{event_name} \
  --header 'Authorization: Bearer <token>'
{
  "event_name": "<string>",
  "version": "<string>",
  "openapi_schema": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "changelog": "Initial schema version"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
event_name
string
required

Response

Successful Response

Model for storing event schemas and their versions

​
event_name
string
required

The name of the event

​
version
string
required

The version of the schema

Pattern: ^\d+\.\d+$
Examples:

"1.0"

"1.1"

"2.0"

​
openapi_schema
string
required

The complete OpenAPI 3.0 document containing the event schema as a JSON string

Example:

"{\"openapi\": \"3.0.0\", \"info\": {\"title\": \"Event Schema\", \"version\": \"1.0.0\"}, \"components\": {\"schemas\": {\"EventSchema\": {\"type\": \"object\", \"properties\": {\"event_name\": {\"type\": \"string\"}}}}}}"

​
created_at
string<date-time>

The date and time the schema was created

​
changelog
string
default:Initial schema version

The changes made to this version of the schema, when compared to the previous version