Login to CortexBook a DemoCortex Academycortex.ioCortex Status

Custom Events

Use these operations to interact with custom events in Cortex.

Required permissions

Edit entities: Your API key must have the Edit entities permission.

Operations

List custom events for entity

get
Authorizations
Path parameters
tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Query parameters
typestringOptional
timestampstring · date-timeOptionalDeprecated

Use 'startTime' instead

startTimestring · date-timeOptional

If provided, events with greater than or equal to timestamp will be returned (a date-time without a time-zone in the ISO-8601 calendar system)

endTimestring · date-timeOptional

If provided, events with less than or equal to timestamp will be returned (a date-time without a time-zone in the ISO-8601 calendar system)

pageSizeinteger · int32Required

Number of results to return per page, between 1 and 1000. Default 250.

Default: 250
pageinteger · int32Required

Page number to return, 0-indexed. Default 0.

Default: 0
Responses
200
Successfully retrieved custom events
application/json
get
GET /api/v1/catalog/{tagOrId}/custom-events HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

{
  "events": [
    {
      "customData": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "description": "text",
      "timestamp": "2025-06-28T18:45:24.068Z",
      "title": "Created K8s pod",
      "type": "POD_CREATION",
      "url": "https://cortex.io",
      "uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}

Retrieve custom event by UUID

get
Authorizations
Path parameters
tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

uuidstring · uuidRequired
Responses
200
Successfully retrieved custom event
application/json
get
GET /api/v1/catalog/{tagOrId}/custom-events/{uuid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

{
  "customData": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "description": "text",
  "timestamp": "2025-06-28T18:45:24.068Z",
  "title": "Created K8s pod",
  "type": "POD_CREATION",
  "url": "https://cortex.io",
  "uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
}

Create custom event for entity

post
Authorizations
Path parameters
tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Body
descriptionstringOptional

Optional description of custom event

timestampstring · date-timeRequired

Time when event occurred

titlestringRequired

Name for custom event

Example: Created K8s pod
typestringRequired

Type of custom event

Example: POD_CREATION
urlstringOptional

Optional URL associated with custom event

Example: https://cortex.io
Responses
200
Successfully created custom event
application/json
post
POST /api/v1/catalog/{tagOrId}/custom-events HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 179

{
  "customData": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "description": "text",
  "timestamp": "2025-06-28T18:45:24.068Z",
  "title": "Created K8s pod",
  "type": "POD_CREATION",
  "url": "https://cortex.io"
}
{
  "customData": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "description": "text",
  "timestamp": "2025-06-28T18:45:24.068Z",
  "title": "Created K8s pod",
  "type": "POD_CREATION",
  "url": "https://cortex.io",
  "uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
}

Update custom event by UUID

put
Authorizations
Path parameters
tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

uuidstring · uuidRequired
Body
descriptionstringOptional

Optional description of custom event

timestampstring · date-timeRequired

Time when event occurred

titlestringRequired

Name for custom event

Example: Created K8s pod
typestringRequired

Type of custom event

Example: POD_CREATION
urlstringOptional

Optional URL associated with custom event

Example: https://cortex.io
Responses
200
Successfully updated custom event
application/json
put
PUT /api/v1/catalog/{tagOrId}/custom-events/{uuid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 179

{
  "customData": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "description": "text",
  "timestamp": "2025-06-28T18:45:24.068Z",
  "title": "Created K8s pod",
  "type": "POD_CREATION",
  "url": "https://cortex.io"
}
{
  "customData": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "description": "text",
  "timestamp": "2025-06-28T18:45:24.068Z",
  "title": "Created K8s pod",
  "type": "POD_CREATION",
  "url": "https://cortex.io",
  "uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
}

Delete ALL custom events for an entity

delete
Authorizations
Path parameters
tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Query parameters
typestringOptional
timestampstring · date-timeOptionalDeprecated

Use 'startTime' instead

startTimestring · date-timeOptional

If provided, events with greater than or equal to timestamp will be deleted (a date-time without a time-zone in the ISO-8601 calendar system)

endTimestring · date-timeOptional

If provided, events with less than or equal to timestamp will be deleted (a date-time without a time-zone in the ISO-8601 calendar system)

Responses
200
Successfully deleted custom events
delete
DELETE /api/v1/catalog/{tagOrId}/custom-events HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content

Delete custom events by UUID

delete
Authorizations
Path parameters
tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

uuidstring · uuidRequired
Responses
200
Successfully deleted custom event
delete
DELETE /api/v1/catalog/{tagOrId}/custom-events/{uuid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content

Last updated

Was this helpful?