Create a hub subscription

Creates a streaming-hub subscription for the tenant and returns the once-shown signing secret. The secret is shown exactly once and is never re-fetchable; the console never stores it. A refusal keeps the hub’s status and carries the hub’s own code in upstream.code: branch on that code, not on the status. On subscription_name_taken (409), existing_id names the live subscription in the caller’s own scope that holds the name. A 2xx or a refusal the hub replays for a reused X-Idempotency key carries X-Idempotency-Replayed: true, and its existing_id may name a subscription deleted since: after acting on it, send the create under a fresh key.

Partner route: the text above describes the tenant’s own route. Here the register id in the path names the fund or originador the partner acts for: it must be in the partner credential’s scope and registered under the caller’s tenant. The partner sees and manages only the subscriptions it created through this register’s routes: the party’s own subscriptions and any other partner’s answer 404, as a missing one does. An originador the bancarizador deactivated is refused 403 ORIGINADOR_DEACTIVATED until it is reactivated.

POST /v1/consignado/originadores/{originador_id}/subscriptions

Create a hub subscription

cURL

curl --request POST \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/originadores/{originador_id}/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "endpoint": "<string>",
  "name": "<string>",
  "sink_kind": "<string>",
  "event_majors": {
    "loan_application.disbursed": 2
  },
  "event_types": [
    "<string>"
  ],
  "origin": "midaz",
  "plan_tier": "<string>",
  "schema_major": 123,
  "timeout_ms": 20000
}
'

201

{
  "signingSecret": "<string>",
  "subscription": {
    "created_at": "2026-01-15T12:00:00Z",
    "enabled": true,
    "id": "0192f1a0-0000-7000-8000-00000000c001",
    "name": "orders-webhook",
    "plan_tier": "standard",
    "signature_version": 1,
    "sink_kind": "webhook",
    "updated_at": "2026-01-15T12:00:00Z",
    "verification_state": "active",
    "delegated_scope": "Rk9ORE8tQQ==",
    "endpoint": "https://hooks.example.com/ingest",
    "event_majors": {
      "loan_application.disbursed": 2
    },
    "event_types": [
      "<string>"
    ],
    "origin": "midaz",
    "schema_major": 2,
    "timeout_ms": 20000
  }
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

Authorization · string

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

X-Idempotency · string · requerido

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

Parámetros de ruta

originador_id · string<uuid> · requerido

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.

Ejemplo:

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

Cuerpo

application/json

endpoint · string · requerido

name · string · requerido

sink_kind · string · requerido

event_majors · object

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

Show child attributes

Ejemplo:

{ "loan_application.disbursed": 2 }

event_types · string[] | null

origin · string

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

Ejemplo:

"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.

Ejemplo:

20000

Respuesta

201

application/json

Created

signingSecret · string · requerido

subscription · object · requerido

Show child attributes