Skip to main content
POST
Create a hub subscription

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

Authorization
string

Bearer token. A tenant route relays it to the streaming-hub as server-to-server auth.

X-Idempotency
string
required

Idempotency key, forwarded to the hub's idempotency middleware, which refuses this mutation without one.

Path Parameters

originador_id
string<uuid>
required

The originador's register id, as returned in the id field of GET /v1/consignado/originadores. It must be in the partner credential's scope.

Example:

"6f1c2a3b-4d5e-4f60-8a7b-9c0d1e2f3a4b"

Body

application/json
endpoint
string
required
name
string
required
sink_kind
string
required
event_majors
object

Per-event-type schema major, overriding schema_major for the types it names.

Example:
event_types
string[] | null
origin
string

Pin the subscription to one producing application (its ce-source); absent means any producer.

Example:

"midaz"

plan_tier
string
schema_major
integer<int64>
timeout_ms
integer<int64>

Per-attempt delivery timeout in milliseconds, from 1000 to 20000, webhook sinks only, validated by the hub; absent or 0 means the hub's default.

Example:

20000

Response

Created

signingSecret
string
required
subscription
object
required