Regal Events API
Contact creation, update, and custom event tracking
Regal Events API is one of 8 APIs that Regal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 4 JSON Schema definitions.
Tagged areas include Events. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a changelog, and 4 JSON Schemas.
This API exposes 1 operation across 1 path, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against a single base URL, https://api.regal.ai/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Regal Events API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (ApiKeyAuth).
By default, every request must be authenticated.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.
Contact creation, update, and custom event tracking
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are CustomEvent (6 properties), ContactTraits (5 properties), PhoneTrait (5 properties), Address (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Regal 7
Other APIs Regal publishes across the network.