cURL
curl --request GET \ --url https://api.vela.dev/v1/apps/{appId}/schemas/by-event-name/{eventName} \ --header 'Authorization: Bearer <token>'
{ "id": "<string>", "appId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "eventName": "<string>", "description": "<string>", "fields": [ { "id": "<string>", "name": "<string>", "type": "string", "required": false, "enumValues": [ "<string>" ] } ], "metadataFields": [ { "id": "<string>", "name": "<string>", "type": "string", "required": false, "enumValues": [ "<string>" ] } ], "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z" }
Returns a single schema by its event name.
Client secret for management API access. Format: vela_cs_...
vela_cs_...
App UUID or slug
Event name (e.g. order.placed)
order.placed
Schema details
Schema identifier
Associated app
Event name (unique per app)
Human-readable description
Event data field definitions
Show child attributes
Metadata field definitions