KEkeboola
Events

Create Event

Creates a new external event. The maximum allowed size of an event is 200KB. If this is exceeded, the HTTP 400 response code is returned.

params and results may be sent either as JSON objects or as serialized JSON object strings.

The branch variant creates the event for the given Development Branch.

post/v2/storage/events

Request

Request body

componentstring required

Name of a registered component the event belongs to.

messagestring required

Event message.

descriptionstring nullable

Event description.

type'info' | 'success' | 'warn' | 'error' nullable

Type of the event. Unknown values fall back to info.

configurationIdstring nullable

Id of a configuration executed by the component.

paramsobject nullable

Custom data.

resultsobject nullable

Custom data.

durationnumber nullable

Duration of the associated task in seconds. Stored as an integer.

runIdstring nullable

Id of the associated component job.

Example request

{
  "component": "keboola.test-component",
  "message": "This is a word of warning",
  "description": "Detailed description of what happened.",
  "type": "warn",
  "configurationId": "123456",
  "params": {
    "command": "sync-test"
  },
  "results": {
    "projectId": "123",
    "otherId": "456"
  },
  "duration": 12,
  "runId": "987654321"
}

Response

Event created.

idstring required

Deprecated, will be removed in the future. Contains the same value as uuid.

uuidstring required

UUID v7 identifier of the created event.

Example response

{
  "id": "01958f48-b1fc-7f05-b9b9-8a4a7b385bc3",
  "uuid": "01958f48-b1fc-7f05-b9b9-8a4a7b385bc3"
}

Changes

No recorded changes to this operation across all 1 revision of this API.