Skip to content

Subscriptions API ​

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

GET /api/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/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.
rulesSíArray de rules. Se requiere al menos una rule.
rules[].triggerSíTrigger fullname.
rules[].conditionsSíConditions object para filtrar la rule.
resourcesSíArray de resource fullnames.
actionsNoDelivery actions.
meta.titleNoSubscription title.
stateNoon o off.

Payload para template subscription:

CampoObligatorioDescripción
template.idSíTemplate id.
template.inputsSíValores para template input schema.
template.topicsSíSelected topic names.
resourcesSíArray de resource fullnames.
actionsNoDelivery actions.
meta.titleNoSubscription title.
stateNoon o off.

Respuesta: SubscriptionView.

GET /api/subscriptions/:id ​

Devuelve una subscription.

Argumentos:

ArgumentoUbicaciónDescripción
idPathSubscription id.

Payload: ninguno.

Respuesta: SubscriptionView.

PUT /api/subscriptions/:id ​

Actualiza una subscription.

Argumentos:

ArgumentoUbicaciónDescripción
idPathSubscription id.

Payload: misma estructura que POST /api/subscriptions.

Respuesta: SubscriptionView.

DELETE /api/subscriptions/:id ​

Elimina una subscription.

Argumentos:

ArgumentoUbicaciónDescripción
idPathSubscription id.

Payload: ninguno.

Respuesta: HTTP 204 No Content con el cuerpo vacío.

PUT /api/subscriptions/:id/state ​

Cambia el state de una subscription.

Argumentos:

ArgumentoUbicaciónDescripción
idPathSubscription id.

Payload:

CampoObligatorioDescripción
stateSíEstado deseado de la subscription: on o off.

Respuesta:

CampoObligatorioDescripción
stateSíEstado efectivo de la subscription: on, off o blocked.
issueNoIncidencia o motivo del estado actual, cuando esté disponible.

POST /api/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/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/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[].