DocumentationNovu Documentation
PlatformGuidesFrameworkCommunityAPI Reference
Sign InSign Up

GitHubnovuhq/novu

38.7K

Retrieve a context

Retrieve a specific context by its type and id. **type** and **id** are required fields, if the context does not exist, it returns the 404 response

Retrieve a specific context by its type and id. type and id are required fields, if the context does not exist, it returns the 404 response

GET
/v2/contexts/{type}/{id}

Authorization

Authorization<token>

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

In: header

Path Parameters

idRequiredstring

Context ID

typeRequiredstring

Context type

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

OK

typeRequiredstring

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

idRequiredstring

Unique identifier for this context

dataRequiredobject

Custom data associated with this context

createdAtRequiredstring

Creation timestamp

updatedAtRequiredstring

Last update timestamp

export interface Response {
  /**
   * Context type (e.g., tenant, app, workspace)
   */
  type: string;
  /**
   * Unique identifier for this context
   */
  id: string;
  /**
   * Custom data associated with this context
   */
  data: {
    [k: string]: unknown;
  };
  /**
   * Creation timestamp
   */
  createdAt: string;
  /**
   * Last update timestamp
   */
  updatedAt: string;
}
 
curl -X GET "https://api.novu.co/v2/contexts/string/string" \
  -H "idempotency-key: string" \
  -H "Authorization: <token>"
{
  "type": "string",
  "id": "string",
  "data": {},
  "createdAt": "string",
  "updatedAt": "string"
}

Create a context POST

Create a new context with the specified type, id, and data. Returns 409 if context already exists. **type** and **id** are required fields, **data** is optional, if the context already exists, it returns the 409 response

Update a context PATCH

Update the data of an existing context. **type** and **id** are required fields, **data** is required. Only the data field is updated, the rest of the context is not affected. If the context does not exist, it returns the 404 response

On this page

No Headings
Edit this page on GitHub