Skip to content

Subscriptions API

Los endpoints Subscription gestionan workspace subscriptions, su state, testing y delivery logs.

GET /api/v1/subscriptions

Devuelve subscriptions del workspace/account actual.

Argumentos: ninguno. El backend filtra la lista por el selected workspace actual.

Payload: ninguno.

Respuesta: SubscriptionView[].

POST /api/v1/subscriptions

Crea una subscription directamente por rules o por template.

Argumentos: ninguno.

Payload para direct trigger subscription:

CampoObligatorioDescripción
templateNoEn direct mode normalmente es null o se omite.
rulesArray de rules. Se requiere al menos una rule.
rules[].triggerTrigger fullname.
rules[].conditionsConditions object para filtrar la rule.
resourcesArray de resource fullnames.
actionsNoDelivery actions.
meta.titleNoSubscription title.
stateNoon o off.

Payload para template subscription:

CampoObligatorioDescripción
template.idTemplate id.
template.inputsValores para template input schema.
template.topicsSelected topic names.
resourcesArray de resource fullnames.
actionsNoDelivery actions.
meta.titleNoSubscription title.
stateNoon o off.

Respuesta: SubscriptionView.

GET /api/v1/subscriptions/:id

Devuelve una subscription.

Argumentos:

ArgumentoUbicaciónDescripción
idPathSubscription id.

Payload: ninguno.

Respuesta: SubscriptionView.

POST /api/v1/subscriptions/:id

Actualiza una subscription.

Argumentos:

ArgumentoUbicaciónDescripción
idPathSubscription id.

Payload: misma estructura que POST /api/v1/subscriptions.

Respuesta: SubscriptionView.

DELETE /api/v1/subscriptions/:id

Elimina una subscription.

Argumentos:

ArgumentoUbicaciónDescripción
idPathSubscription id.

Payload: ninguno.

Respuesta: OperationResult.

POST /api/v1/subscriptions/:id/state

Cambia el state de una subscription.

Argumentos:

ArgumentoUbicaciónDescripción
idPathSubscription id.

Payload:

CampoObligatorioDescripción
stateon, off o blocked.
issueNoRazón legible para humanos del bloqueo/desactivación.

Respuesta: SubscriptionView.

POST /api/v2/subscriptions/test

Prueba una subscription existente o una draft subscription.

Argumentos: ninguno.

Payload:

CampoObligatorioDescripción
subscriptionUno deId de subscription existente.
draftUno deDraft payload con la misma estructura que subscription.save.params.
ruleIndexNoÍndice de rule para probar.
modeNopreview o send.
inputNoRaw source item/test input.
test.sourceNoSource item object.
test.itemIndexNoSource item index.
test.match.hashNoExisting match hash.
test.match.indexNoExisting match index.

Respuesta: SubscriptionTestResult.

GET /api/v2/subscriptions/alerts/history

Devuelve subscription logs del workspace actual.

Argumentos:

ArgumentoUbicaciónDescripción
limitQuery50, 100, 250 o 500.
statusQuerydelivered, failed, rate_limited, blocked.
directionQuerybefore o after.
datetimeQueryCursor date-time.

Payload: ninguno.

Respuesta: SubscriptionAlertLog[].

GET /api/v2/subscriptions/:id/alerts/history

Devuelve logs de una subscription concreta.

Argumentos:

ArgumentoUbicaciónDescripción
idPathSubscription id.
limitQuery50, 100, 250 o 500.
statusQueryFiltro opcional por status.
directionQuerybefore o after.
datetimeQueryCursor date-time.

Payload: ninguno.

Respuesta: SubscriptionAlertLog[].