Skip to main content
POST
Create a subscription

Authorizations

Authorization
string
header
required

A bearer JWT issued by plugin-auth (lib-auth). The tenant identity is resolved from the validated token claims; the /v1 surface never reads a tenant from the body, path, or query. Machine callers obtain a token via the plugin-auth client-credentials flow. The /admin surface authorizes against an operator scope and carries no tenant context.

Headers

X-Idempotency
string
required

A client-chosen unique key that makes this mutation at-most-once. A mutation sent without it is rejected before any write with 400 missing_idempotency_key. Reusing the same key with an identical request replays the original response byte-for-byte (with X-Idempotency-Replayed: true); reusing it with a different request body returns 409 idempotency_conflict. To re-drive a corrected request, mint a new key.

Body

application/json

The create body. It carries no tenant_id (the tenant is resolved from the JWT). Inline sink_config / credential fields are rejected with 422 inline_sink_config_forbidden — queue credentials arrive only via the credential PUT.

name
string
required

A human label for the subscription. Required and non-blank (whitespace-only is rejected).

Example:

"orders-webhook"

sink_kind
enum<string>
required

The delivery destination kind. webhook posts signed HTTPS requests; pull exposes an inbox read over GET /v1/events; sqs, rabbitmq, and eventbridge fan out to the named queue or bus.

Available options:
webhook,
pull,
sqs,
rabbitmq,
eventbridge
endpoint
string

The destination address, interpreted per sink kind. For webhook, an https:// URL with no embedded userinfo. For pull, omit it — the server synthesizes a pull://<id> value. For sqs, the https:// queue URL. For rabbitmq, an "<exchange>/<routingKey>" string (exchange required, routing key optional). For eventbridge, the event-bus name / detail-type addressing string. The broker host or AWS region for queue kinds lives in the encrypted credential, not here.

Example:

"https://hooks.example.com/lerian"

event_types
string[]

The event types to deliver. Validated softly against the catalog — an unknown type warns but never blocks onboarding.

Example:
schema_major
integer

Optional schema-major pin. When set, delivery follows the versioned topic for that major; when omitted, the subscription follows the base topic.

Example:

1

plan_tier
string

The plan tier for the subscription.

Example:

"standard"

Response

The subscription was created. signingSecret is present only for a webhook sink and is shown exactly once — save it on receipt, it cannot be retrieved later, only rotated.

The create response. signingSecret is present only for a webhook sink and is shown exactly once; it is stored only as ciphertext and is never returned by any read path.

subscription
object
required

The non-secret projection of a subscription. It never carries the signing secret or any credential material.

signingSecret
string

The one-time webhook signing secret (write-only). Minted server-side, returned exactly once here, and never retrievable later — only rotated. Absent for non-webhook sinks.

Example:

"whsec_9f8c2b1e4a7d6055c3e2f10987ab4c21"