Schemas

Get a validation schema

Returns the publicly accessible JSON validation schema that the back end uses to validate the request body for a given event type. These schemas are the authority for which parameters are required or optional, and their data types.

get/schemas/{eventType}

Request

  • Base URL: https://example.hb-api.omtrdc.net/api/v1
  • URL: https://example.hb-api.omtrdc.net/api/v1/schemas/{eventType}
  • Auth: none declared

Path parameters

eventTypestring required

The event type to retrieve the schema for, for example sessionStart or ping.

Response

The JSON validation schema for the requested event type.

object required

Changes

No recorded changes to this operation across all 4 revisions of this API.