Creates a subscription.

POST

/v1/m/eventing/subscriptions

curl --request POST \
  --url https://example.com/v1/m/eventing/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '"example"'

• this engine

Creates a subscription. The signing secret is generated server-side (never caller-supplied: entropy is guaranteed), sealed for storage, and returned EXACTLY ONCE in the response.

Authorizations

• bearerAuth

Parameters

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Request Body ^required

Media type application/json

object

auth_header_name

string

<= 200 characters

auth_type

Per-subscription authentication header type. Empty selects none.

string

Allowed values: "" none bearer basic header

auth_value

string

<= 2048 characters

description

string

<= 1024 characters

enabled

Any of:

boolean

boolean

null

null

endpoint

required

HTTPS delivery destination; configured loopback development may also accept HTTP. Deployment egress-policy and DNS/IP safety checks also apply.

string

>= 1 characters <= 2048 characters

event_types

required

Array<string>

>= 1 items <= 32 items

initial_interval_seconds

Any of:

integer

integer format: int64

0

integer

integer format: int64

>= 5 <= 3600

match_sources

Array<string>

<= 32 items

max_attempts

integer format: int64

<= 20

name

required

string

>= 1 characters <= 200 characters

role

Delivery authorization role. Empty selects viewer; the caller cannot assign a role above its own.

string

Allowed values: "" viewer editor admin owner

sink_cred

string

<= 2048 characters

sink_format

SIEM wire dialect. Empty selects the eventing surface default (ocsf).

string

Allowed values: "" ocsf cef leef syslog otlp otlp_envelope json

sink_kind

SIEM sink kind. Empty selects the generic HMAC-signed webhook.

string

Allowed values: "" https splunk_hec sentinel_dcr datadog newrelic

sink_opts

object

<= 32 properties

key

additional properties

string

<= 2048 characters

Responses

200

OK

Media type application/json

object

Example ^generated

{}

400

Bad request

Media type application/json

object

Example ^generated

{}

401

Unauthenticated

Media type application/json

object

Example ^generated

{}

403

Forbidden

Media type application/json

object

Example ^generated

{}

404

Not found

Media type application/json

object

Example ^generated

{}

409

Conflict / setup required

Media type application/json

object

Example ^generated

{}

429

Rate limited

Media type application/json

object

Example ^generated

{}