Access Pismo event schemas on GitHub
To access the JSON schemas for the events documented in the Events reference, you can download them from the public Pismo GitHub repo. Once you have these files, you can validate incoming event payloads, generate data models, and build data pipelines that use the schemas as contracts.
You can use the Git commit history to review all changes to the event schemas over time. For information about event structure, validation, and other ways to retrieve schemas, refer to Data events.
Get Pismo event schema files
The repository for the Pismo event schemas is at github.com/PismoDevEx/pismo-api-specs. You can clone or download the files, then open the pismo-api-specs/published-event-schemas folder to view all event schemas in JSON format.
The folder has this structure:
- The main-event.json file contains the base contract, the fields common to every event.
- Each subfolder represents an event
domain, such asaccount,authorization, orcards. - Each file in a domain folder is the JSON schema for one event, with the schema version at the end of the file name.
For example, you find version 2 of the account change event schema in the file, published-event-schemas/account/account_change-2.json.
Next steps
Many use cases exist with access to the event JSON schema files. You can:
- Validate incoming event payloads with your preferred JSON Schema validator.
- Generate data models or classes for your preferred programming language.
- Build data pipelines and integration workflows that use event schemas as contracts.
- Detect line-by-line changes to the event schemas by viewing the Git commit history.
Updated 1 day ago