List the workspace's events, newest first by default.

With after, only later events, in ascending order unless order says otherwise; with wait, an empty page waits up to that many seconds (at most 25) for an event to arrive.

GET/v1/events

Authorization

AuthorizationBearer token · headerrequired

An API key (nb_live_…, nb_test_…), a workspace token (nbs_…) or a CLI token (nbc_…).

Query parameters

limitinteger<int64>

Events per page, 1 to 100 (default 20).

cursorstring

The next_cursor of the previous page.

orderListOrder

desc or asc; asc by default with after, desc otherwise.

Allowed:descasc

includeListInclude

total_count adds an exact count up to 10,000.

Allowed:total_count

typeEventType

Only events of this type.

Allowed:message.queuedmessage.sentmessage.failedmessage.uncertainmessage.cancelledmessage.snippets_fallbackdelivery_event.recordedinbound_message.receivedenrollment.stoppedenrollment.completedcampaign.status_changedconnection.health_changedimport.completedexport.completedsuppression.createdai.budget_warningai.budget_exceededendpoint.testwebhook_endpoint.disabled

afterId_OutboxEvent

Only events after this one.

matches ^evt_[0-9a-f]{32}$

waitinteger<int64>

Seconds to wait for a first event when the page would be empty, 0 to 25.

min 0

Responses

200

A page of events.

dataobject[]required

At most limit rows, 100 at most.

max items 100

Show properties

Array of object

created_atTimestamprequired

dataanyrequired

What consumers receive.

idId_OutboxEventrequired

matches ^evt_[0-9a-f]{32}$

syntheticbooleanrequired

True for an event created on request (POST /events) rather than by a real change.

typeEventTyperequired

The type of an event: the closed vocabulary webhook endpoints subscribe to. New types may be added.

webhook_endpoint_idId_WebhookEndpoint | null

Show properties

One of:

Id_WebhookEndpoint

string

null

null

metaMetarequired

The page metadata.

Show properties

has_morebooleanrequired

next_cursorstring | null

total_countinteger<int64> | null

With ?include=total_count: exact up to 10,000.

total_count_cappedboolean | null

With ?include=total_count: true when the count stopped at 10,000.

400

The cursor is not valid for this request.

codeProblemCoderequired

The closed registry of problem codes: programs branch on a problem's code, never on its text. A code may be added, never repurposed.

Allowed:invalid_requestunauthorizedforbiddensession_requirednot_foundarchivedmethod_not_allowedconflictinvalid_stateidempotency_in_progressprecondition_failedpayload_too_largeunsupported_media_typevalidation_failedidempotency_mismatchsuppressedcaptcha_failedinsufficient_scoperate_limitedquota_exceededinternal_errorservice_unavailabletimeout

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties

Array of FieldError

codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0

statusinteger<int32>required

The HTTP status.

min 0

titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

401

No valid credential.

codeProblemCoderequired

The closed registry of problem codes: programs branch on a problem's code, never on its text. A code may be added, never repurposed.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties

Array of FieldError

codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0

statusinteger<int32>required

The HTTP status.

min 0

titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

403

The credential lacks automation:read.

codeProblemCoderequired

The closed registry of problem codes: programs branch on a problem's code, never on its text. A code may be added, never repurposed.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties

Array of FieldError

codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0

statusinteger<int32>required

The HTTP status.

min 0

titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

422

A parameter is invalid.

codeProblemCoderequired

The closed registry of problem codes: programs branch on a problem's code, never on its text. A code may be added, never repurposed.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties

Array of FieldError

codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0

statusinteger<int32>required

The HTTP status.

min 0

titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

limitqueryEvents per page, 1 to 100 (default 20).cursorqueryThe `next_cursor` of the previous page.orderquery`desc` or `asc`; `asc` by default with `after`, `desc` otherwise.includequery`total_count` adds an exact count up to 10,000.typequeryOnly events of this type.afterqueryOnly events after this one.waitquerySeconds to wait for a first event when the page would be empty, 0 to 25.

Request

curl -X GET 'https://api.norbelys.com/v1/events' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://api.norbelys.com/v1/events", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.norbelys.com/v1/events",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "data": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "data": null,
      "id": "evt_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
      "synthetic": true,
      "type": "message.queued",
      "webhook_endpoint_id": "whe_0190f8a2b4c87a10b6d2e4f6a8c0e2f4"
    }
  ],
  "meta": {
    "has_more": true,
    "next_cursor": "string",
    "total_count": 0,
    "total_count_capped": true
  }
}

{
  "code": "invalid_request",
  "detail": "string",
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "pointer": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "retry_after": 0,
  "status": 0,
  "title": "string",
  "type": "string"
}

{
  "code": "invalid_request",
  "detail": "string",
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "pointer": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "retry_after": 0,
  "status": 0,
  "title": "string",
  "type": "string"
}

{
  "code": "invalid_request",
  "detail": "string",
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "pointer": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "retry_after": 0,
  "status": 0,
  "title": "string",
  "type": "string"
}

{
  "code": "invalid_request",
  "detail": "string",
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "pointer": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "retry_after": 0,
  "status": 0,
  "title": "string",
  "type": "string"
}