Create a topic

Creates a new topic if it does not exist, or updates an existing topic if it already exists. Use ?failIfExists=true to prevent updates.

Authorization

Authorization<token>

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

In: header

Request Body

application/jsonRequired

keyRequiredstring

The unique key identifier for the topic. The key must contain only alphanumeric characters (a-z, A-Z, 0-9), hyphens (-), underscores (_), colons (:), or be a valid email address.

Minimum length: 1Maximum length: 100

namestring

The display name for the topic

Minimum length: 0Maximum length: 100

Query Parameters

failIfExistsboolean

If true, the request will fail if a topic with the same key already exists

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

_idRequiredstring

The identifier of the topic

keyRequiredstring

The unique key of the topic

namestring

The name of the topic

createdAtstring

The date the topic was created

updatedAtstring

The date the topic was last updated

export interface Response {
  /**
   * The identifier of the topic
   */
  _id: string;
  /**
   * The unique key of the topic
   */
  key: string;
  /**
   * The name of the topic
   */
  name?: string;
  /**
   * The date the topic was created
   */
  createdAt?: string;
  /**
   * The date the topic was last updated
   */
  updatedAt?: string;
}

curl -X POST "https://api.novu.co/v2/topics?failIfExists=true" \
  -H "idempotency-key: string" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "task:12345",
    "name": "Task Title"
  }'