Skip to main content
GET
Retrieve custom event by UUID

Authorizations

Authorization
string
header
required

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path Parameters

tagOrId
string
required

The tag (x-cortex-tag) or unique, auto-generated identifier (CID) for the entity. If the tag contains forward slashes, URL-encode each / as %2F. The tag is matched exactly as encoded, including leading, trailing, and consecutive slashes, which are preserved and not collapsed (for example, the tag /services/payments-api is referenced as %2Fservices%2Fpayments-api). Tags containing slashes are supported via the API but not in the Cortex UI; this difference is expected. Entity identifier - can be a tag or CID

uuid
string<uuid>
required

Response

Successfully retrieved custom event

timestamp
string<date-time>
required

Time when event occurred

title
string
required

Name for custom event

Example:

"Created K8s pod"

type
string
required

Type of custom event

Example:

"POD_CREATION"

uuid
string<uuid>
required

Automatically generated identifier

Example:

"d853c6e0-1bca-40bf-a264-db5d4ee38d77"

customData
object

Optional property to store additional data

description
string

Optional description of custom event

url
string

Optional URL associated with custom event

Example:

"https://cortex.io"

Last modified on September 29, 2026