Skip to main content
POST
TypeScript

Authorizations

Authorization
string
header
required

API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".

Headers

idempotency-key
string

A header for idempotency purposes

Body

application/json
type
string
required

Context type (e.g., tenant, app, workspace). Must be lowercase alphanumeric with optional separators.

Required string length: 1 - 100
Pattern: ^[a-zA-Z0-9_-]+$
Example:

"tenant"

id
string
required

Unique identifier for this context. Must be lowercase alphanumeric with optional separators.

Required string length: 1 - 100
Pattern: ^[a-zA-Z0-9_-]+$
Example:

"org-acme"

data
object

Optional custom data to associate with this context.

Example:

Response

Created

type
string
required

Context type (e.g., tenant, app, workspace)

id
string
required

Unique identifier for this context

data
object
required

Custom data associated with this context

createdAt
string
required

Creation timestamp

updatedAt
string
required

Last update timestamp