Skip to main content
POST
Create a new event

Authorizations

x-api-token
string
header
required

API token for authentication (or Admin API key). The token is scoped per organization and can be retrieved in the Organization Switcher.

Body

application/json
name
string
required

Name of the event (minimum 5 characters)

Minimum string length: 5
date
string<date-time> | null
required

Date of the event (ISO 8601 format or parseable date string)

description
string
required

Detailed description of the event

category
enum<string>
default:BUSINESS

Category of the event: BUSINESS, TECHNICAL, or PROVIDER (defaults to BUSINESS)

Available options:
BUSINESS,
TECHNICAL,
PROVIDER
metadata
object

Additional metadata about the event (key-value pairs). Example: source, event, owner, link

labels
string[]

Labels/tags for the event (maximum 5)

Maximum array length: 5

Response

Event created successfully

id
string
required

The unique identifier of the created event

Last modified on August 10, 2026