Skip to content

API ​

Web3alert API permite trabajar con las mismas entidades que la web UI: workspaces, projects, triggers, templates, subscriptions, resources, data sources y addresses.

Base URL:

text
https://web3alert.io

Todos los endpoints públicos para clientes usan rutas canónicas /api/*. Los endpoints entre servicios no forman parte de esta referencia pública.

Auth ​

Las peticiones de usuario usan personal access token:

http
Authorization: Bearer YOUR_PERSONAL_ACCESS_TOKEN

Token puede obtenerse en Account parameters.

El acceso a endpoint depende de:

  • account tier;
  • rol del usuario en workspace;
  • access level de project/data source/resource;
  • estado de la entidad.

External API requests están limitadas por tier. Los valores detallados se describen en Limits.

Response format ​

Un response correcto devuelve JSON del endpoint.

Las estructuras detalladas del response body están descritas en Types.

El error se devuelve en este formato:

json
{
  "error": {
    "message": "error message",
    "details": {}
  }
}

Al superar el límite de external API se devuelve 429 y headers:

http
Retry-After: 10
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 0
X-RateLimit-Window: 60000

Account ​

Detalles: Account API.

MethodEndpointPurpose
POST/api/tokenAutenticar la identity con credentials del provider y crear un Bearer token nuevo y persistente; no requiere un Bearer token existente.
GET/api/meObtener account actual, identity, tier y memberships.
DELETE/api/meEliminar account actual.
PUT/api/me/metaActualizar account metadata.
POST/api/me/avatarSubir avatar del account actual.
GET/api/me/workspaceObtener workspace account actual.
PUT/api/me/workspaceCambiar workspace account actual.
GET/api/account/settingsObtener account settings.
PUT/api/account/settingsGuardar account settings.

Enlaces ​

Detalles: API de enlaces.

MétodoEndpointFinalidad
POST/api/linksCrear un enlace corto anónimo para una ruta interna de Web3alert.
GET/api/links/:keyResolver una clave anónima; una clave desconocida devuelve 400.

Workspaces ​

Detalles: Workspaces API.

MethodEndpointPurpose
GET/api/workspacesListar workspaces del account actual.
GET/api/workspaces/:fullnameObtener workspace.
PUT/api/workspaces/:fullnameCrear o actualizar workspace.
DELETE/api/workspaces/:fullnameEliminar workspace.
POST/api/workspaces/:fullname/avatarSubir workspace avatar.
GET/api/workspaces/:workspace/aclObtener members/ACL del workspace.
POST/api/workspaces/:workspace/aclCrear invite o ACL entry.
PUT/api/workspaces/:workspace/acl/:entryIdCambiar rol de member.
DELETE/api/workspaces/:workspace/acl/:entryIdEliminar member/ACL entry.

Projects ​

Detalles: Projects API.

MethodEndpointPurpose
GET/api/projectsListar projects disponibles.
GET/api/projects/create-capabilityComprobar capacidad de crear project.
GET/api/projects/:fullnameObtener project.
PUT/api/projects/:fullnameCrear o actualizar project.
DELETE/api/projects/:fullnameEliminar project.
GET/api/projects/by-link/:tokenAbrir private project por access link.
POST/api/projects/:fullname/access-linksCrear access link para project.
POST/api/projects/:fullname/assets/imagesSubir project icon o cover.
DELETE/api/projects/:fullname/images/:assetEliminar uploaded project image.

Project Transfers ​

Detalles: Project Transfers API.

MethodEndpointPurpose
POST/api/projects/:fullname/transfer/planObtener plan de transferencia de project.
POST/api/projects/:fullname/transfer-requestsCrear transfer request.
GET/api/project-transfer-requestsListar incoming/outgoing transfer requests.
POST/api/project-transfer-requests/:id/acceptAceptar transfer request.
POST/api/project-transfer-requests/:id/rejectRechazar transfer request.
POST/api/project-transfer-requests/:id/cancelCancelar outgoing transfer request.

Triggers ​

Detalles: Triggers API.

MethodEndpointPurpose
GET/api/triggersListar triggers con filters.
GET/api/triggers/:fullnameObtener trigger.
PUT/api/triggers/:fullnameCrear o guardar trigger completo.
PATCH/api/triggers/:fullnameActualizar trigger parcialmente.
DELETE/api/triggers/:fullnameEliminar trigger.
POST/api/triggers/patchBulk patch de triggers.
POST/api/triggers/removeBulk remove de triggers.
GET/api/triggers/:fullname/draftObtener draft view de trigger.
PUT/api/triggers/:fullname/draftGuardar trigger draft.
POST/api/triggers/:fullname/draft/validateValidar trigger draft.
GET/api/triggers/:fullname/logsObtener logs agregados de delivery y source pressure.
POST/api/triggers/:fullname/reset-test-statusRestablecer el estado de test del trigger.
POST/api/triggers/previewPreview de activation y transforms sobre un input.
POST/api/triggers/testTest de trigger con sample source item.
POST/api/triggers/test-blockTest de trigger en block concreto.
POST/api/triggers/providers/testTest de un provider.
GET/api/triggers/hypercore/actionsListar actions de HyperCore disponibles en el builder.
GET/api/triggers/runtime-sourcesListar runtime data sources.
GET/api/template-helpersListar metadatos públicos de helpers de Handlebars para plantillas de triggers y actions.
POST/api/triggers/find-latest-blockBuscar o preparar test input/block para trigger.

Trigger Import ​

Detalles: Trigger Import API.

MethodEndpointPurpose
POST/api/triggers/import/evmCargar EVM ABI entries sin guardar triggers.
POST/api/triggers/import/evm/abiDetectar/cargar ABI por contract address.
POST/api/triggers/import/evm/draftsGenerar EVM trigger drafts.
POST/api/triggers/import/hypercore/draftsGenerar HyperCore trigger drafts.
POST/api/triggers/import/solana/idlCargar metadata de Solana IDL.
POST/api/triggers/import/solana/draftsGenerar Solana trigger drafts.
POST/api/triggers/import/substrate/draftsGenerar Substrate trigger drafts.
GET/api/triggers/substrate/sourceObtener Substrate source info.
GET/api/triggers/substrate/palletsObtener lista de Substrate pallets.
GET/api/triggers/substrate/palletObtener metadata de un Substrate pallet.

Templates ​

Detalles: Templates API.

MethodEndpointPurpose
GET/api/projects/:fullname/templatesListar templates del project.
GET/api/projects/:fullname/templateObtener root template del project.
POST/api/projects/:fullname/templatesCrear template/group.
GET/api/projects/:fullname/templates/:idObtener template.
PUT/api/projects/:fullname/templates/:idActualizar template.
DELETE/api/projects/:fullname/templates/:idEliminar template.

Subscriptions ​

Detalles: Subscriptions API.

MethodEndpointPurpose
GET/api/subscriptionsListar subscriptions del workspace/account actual.
POST/api/subscriptionsCrear subscription.
GET/api/subscriptions/:idObtener subscription.
PUT/api/subscriptions/:idActualizar subscription.
DELETE/api/subscriptions/:idEliminar subscription.
PUT/api/subscriptions/:id/stateActivar o desactivar subscription.
POST/api/subscriptions/testTest de subscription.
GET/api/subscriptions/alerts/historyWorkspace subscription logs.
GET/api/subscriptions/:id/alerts/historyLogs de una subscription concreta.

Resources ​

Detalles: Resources API.

MethodEndpointPurpose
GET/api/resourcesListar resources.
GET/api/resources/:fullnameObtener resource.
PUT/api/resources/:fullnameCrear o actualizar resource.
DELETE/api/resources/:fullnameEliminar resource.
POST/api/resources/:fullname/setup-sessionsIniciar una setup session de destino Telegram.
GET/api/resources/:fullname/setup-sessions/:idObtener el estado de la setup session.
DELETE/api/resources/:fullname/setup-sessions/:idCancelar la setup session.
GET/api/resources/external/:tokenAbrir external resource setup por token.
POST/api/resources/external/:tokenEnviar external resource setup payload.

Las tres rutas de setup session solo están disponibles cuando el setup seguro del destino Telegram está habilitado en el servidor.

Data Sources ​

Detalles: Data Sources API.

MethodEndpointPurpose
GET/api/custom-sourcesListar custom data sources.
GET/api/custom-sources/create-capabilityComprobar capacidad de crear custom source.
POST/api/custom-sources/verifyVerificar custom source config.
GET/api/custom-sources/:fullnameObtener custom source.
PUT/api/custom-sources/:fullnameCrear o actualizar custom source.
DELETE/api/custom-sources/:fullnameEliminar custom source.
GET/api/custom-sources/:fullname/logsObtener custom source logs.
POST/api/custom-sources/:fullname/test-statusComprobar status de custom source.
POST/api/custom-sources/:fullname/restartReiniciar custom source.
POST/api/custom-sources/:fullname/reset-lagResetear lag de custom source.

Facturación ​

Detalles: API de facturación.

MethodEndpointPurpose
GET/api/billing/overviewObtener el resumen de facturación de la cuenta.
GET/api/billing/wallet/overviewObtener el resumen del saldo y del monedero.
POST/api/billing/wallet/crypto-topupCrear una recarga de saldo con criptomonedas.
POST/api/billing/wallet/topup/refreshActualizar el estado de una recarga.
POST/api/billing/account-plan/balance-purchaseComprar o mejorar un plan con saldo.
POST/api/billing/account-plan/checkoutCrear un checkout para un plan de cuenta.
POST/api/billing/account-plan/crypto-checkoutCrear un checkout directo con criptomonedas para un plan.
POST/api/billing/project-addon/balance-purchaseComprar un add-on de proyecto con saldo.
POST/api/billing/project-addon/checkoutCrear un checkout para un add-on de proyecto.
POST/api/billing/project-addon/crypto-checkoutCrear un checkout directo con criptomonedas para un add-on.
POST/api/billing/coupon/redeemCanjear un cupón.
POST/api/billing/coupon/gift-purchaseComprar un cupón regalo con saldo.
GET/api/billing/referral/overviewObtener el resumen de saldo y enlace de referidos.
POST/api/billing/referral/link/createCrear un enlace de referido.
POST/api/billing/referral/claimReclamar un código de referido.
POST/api/billing/subscription/update-renewalActualizar la renovación automática.
POST/api/billing/crypto-checkout/refreshActualizar el estado de un crypto checkout.
POST/api/billing/crypto-checkout/cancelCancelar un crypto checkout.

Addresses ​

Detalles: Addresses API.

MethodEndpointPurpose
GET/api/addressesListar addresses.
POST/api/addressesCrear address.
PUT/api/addresses/:idActualizar address.
DELETE/api/addresses/:idEliminar address.

Apps, Actions, Blueprints and Types ​

Detalles: Apps, Actions, Blueprints and Types API.

MethodEndpointPurpose
GET/api/appsListar apps.
GET/api/apps/:fullnameObtener app.
PUT/api/apps/:fullnameCrear o actualizar app.
DELETE/api/apps/:fullnameEliminar app.
GET/api/actionsListar actions.
GET/api/actions/:fullnameObtener action.
PUT/api/actions/:fullnameCrear o actualizar action.
DELETE/api/actions/:fullnameEliminar action.
GET/api/blueprintsListar blueprints.
GET/api/blueprints/:fullnameObtener blueprint.
PUT/api/blueprints/:fullnameCrear o actualizar blueprint.
DELETE/api/blueprints/:fullnameEliminar blueprint.
GET/api/typesListar shared types.
GET/api/types/lookupResolver opciones dinámicas de tipos.
GET/api/types/:fullnameObtener shared type.
PUT/api/types/:fullnameCrear o actualizar shared type.
DELETE/api/types/:fullnameEliminar shared type.