Create a synthetic event with sample data of its type. It is delivered like any other event, to every subscribed endpoint, or only to `webhook_endpoint_id` when given.

POST/v1/events

Authorization

AuthorizationBearer token · headerrequired

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

Header parameters

Idempotency-Keystringrequired

A stable key for this logical request; reuse it when retrying.

min length 1 · max length 128 · matches ^[!-~]+$

Request body

requiredapplication/json

typeEventTyperequired

The type of the synthetic event.

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

webhook_endpoint_idstring | null

Address the event to this endpoint only, whatever its subscriptions.

Responses

201

The synthetic event; its deliveries appear within seconds.

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.

typestringrequired

The event's type, such as message.sent. New types may be added.

webhook_endpoint_idId_WebhookEndpoint | null

Show properties

One of:

Id_WebhookEndpoint

string

null

null

401

No valid credential.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

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:manage.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

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.

404

No such endpoint in this workspace.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

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

The body is invalid.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

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

Idempotency-Keyheader*A stable key for this logical request; reuse it when retrying.

Bodyapplication/json

typestring*webhook_endpoint_idstringAddress the event to this endpoint only, whatever its subscriptions.

Request

curl -X POST 'https://api.norbelys.com/v1/events' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Idempotency-Key: string' \
  -H 'Content-Type: application/json' \
  -d '{
  "type": "endpoint.test",
  "webhook_endpoint_id": "whe_0190f8a2b4c87a10b6d2e4f6a8c0e2f4"
}'

const response = await fetch("https://api.norbelys.com/v1/events", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Idempotency-Key": "string",
    "Content-Type": "application/json"
  },
  body: "{\n  \"type\": \"endpoint.test\",\n  \"webhook_endpoint_id\": \"whe_0190f8a2b4c87a10b6d2e4f6a8c0e2f4\"\n}"
});

import requests

response = requests.post(
    "https://api.norbelys.com/v1/events",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Idempotency-Key": "string",
        "Content-Type": "application/json"
    },
    data="{\n  \"type\": \"endpoint.test\",\n  \"webhook_endpoint_id\": \"whe_0190f8a2b4c87a10b6d2e4f6a8c0e2f4\"\n}",
)

Response

{
  "created_at": "2019-08-24T14:15:22Z",
  "data": null,
  "id": "evt_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
  "synthetic": true,
  "type": "string",
  "webhook_endpoint_id": "whe_0190f8a2b4c87a10b6d2e4f6a8c0e2f4"
}

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

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

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

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