events

Get event vocabulary

Changed on

Returns a delivery event vocabulary by name.

get/event-vocabularies/{name}

Request

Path parameters

namestring required

Event vocabulary name in reverse-domain notation (e.g., xyz.localprotocol.delivery.courier).

Response

The event vocabulary.

namestring required

Standard identifier in reverse-domain notation (e.g., xyz.localprotocol.delivery.courier).

versionstring required

Version in YYYY-MM-DD format.

extendsstring[]

Parent standard this standard extends (optional). Only one parent is allowed; the reference must include a version date. Used for lineage and discovery.

titlestring required

Human-readable title for the standard.

descriptionstring required

Human-readable description of the standard.

specstring uri

URL to human-readable specification document.

eventsobject required

Map of all event IDs supported by this standard, including inherited events.

Changes