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

La versión principal de API para marketplace y builder functionality es v2. Parte de los endpoints de account/subscription/address book todavía permanece en v1.

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/v1/tokenCrear u obtener API token después de auth flow.
GET/api/v1/meObtener account actual, identity, tier y memberships.
DELETE/api/v1/meEliminar account actual.
PUT/api/v1/me/metaActualizar account metadata.
POST/api/v1/me/avatarSubir avatar del account actual.
GET/api/v1/me/workspaceObtener workspace account actual.
POST/api/v1/me/workspaceCambiar workspace account actual.
GET/api/v1/account/settingsObtener account settings.
POST/api/v1/account/settingsGuardar account settings.

Workspaces

Detalles: Workspaces API.

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

Projects

Detalles: Projects API.

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

Project Transfers

Detalles: Project Transfers API.

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

Triggers

Detalles: Triggers API.

MethodEndpointPurpose
GET/api/v2/triggersListar triggers con filters.
GET/api/v2/triggers/:fullnameObtener trigger.
PUT/api/v2/triggers/:fullnameCrear o guardar trigger completo.
PATCH/api/v2/triggers/:fullnameActualizar trigger parcialmente.
DELETE/api/v2/triggers/:fullnameEliminar trigger.
POST/api/v2/triggers/patchBulk patch de triggers.
POST/api/v2/triggers/removeBulk remove de triggers.
GET/api/v2/triggers/:fullname/draftObtener draft view de trigger.
PUT/api/v2/triggers/:fullname/draftGuardar trigger draft.
POST/api/v2/triggers/:fullname/draft/validateValidar trigger draft.
POST/api/v2/triggers/previewPreview de ejecución de trigger.
POST/api/v2/triggers/testTest de trigger con sample source item.
POST/api/v2/triggers/test-blockTest de trigger en block concreto.
POST/api/v2/triggers/providers/testTest de un provider.
GET/api/v2/triggers/runtime-sourcesListar runtime data sources.
POST/api/v2/triggers/find-latest-blockBuscar o preparar test input/block para trigger.

Trigger Import

Detalles: Trigger Import API.

MethodEndpointPurpose
POST/api/v2/triggers/import/evmCargar EVM ABI entries.
POST/api/v2/triggers/import/evm/abiDetectar/cargar ABI por contract address.
POST/api/v2/triggers/import/evm/draftsGenerar EVM trigger drafts.
POST/api/v2/triggers/import/substrate/draftsGenerar Substrate trigger drafts.
GET/api/v2/triggers/substrate/sourceObtener Substrate source info.
GET/api/v2/triggers/substrate/palletsObtener lista de Substrate pallets.
GET/api/v2/triggers/substrate/palletObtener metadata de un Substrate pallet.

Templates

Detalles: Templates API.

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

Subscriptions

Detalles: Subscriptions API.

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

Resources

Detalles: Resources API.

MethodEndpointPurpose
GET/api/v2/resourcesListar resources.
GET/api/v2/resources/:fullnameObtener resource.
PUT/api/v2/resources/:fullnameCrear o actualizar resource.
DELETE/api/v2/resources/:fullnameEliminar resource.
GET/api/v2/resources/external/:tokenAbrir external resource setup por token.
POST/api/v2/resources/external/:tokenEnviar external resource setup payload.

Data Sources

Detalles: Data Sources API.

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

Addresses

Detalles: Addresses API.

MethodEndpointPurpose
GET/api/v1/addressbookListar addresses.
POST/api/v1/addressbookCrear address.
POST/api/v1/addressbook/:idActualizar address.
DELETE/api/v1/addressbook/:idEliminar address.

Apps, Actions, Blueprints and Types

Detalles: Apps, Actions, Blueprints and Types API.

MethodEndpointPurpose
GET/api/v2/appsListar apps.
GET/api/v2/apps/:fullnameObtener app.
PUT/api/v2/apps/:fullnameCrear o actualizar app.
DELETE/api/v2/apps/:fullnameEliminar app.
GET/api/v2/actionsListar actions.
GET/api/v2/actions/:fullnameObtener action.
PUT/api/v2/actions/:fullnameCrear o actualizar action.
DELETE/api/v2/actions/:fullnameEliminar action.
GET/api/v2/blueprintsListar blueprints.
GET/api/v2/blueprints/:fullnameObtener blueprint.
PUT/api/v2/blueprints/:fullnameCrear o actualizar blueprint.
DELETE/api/v2/blueprints/:fullnameEliminar blueprint.
GET/api/v2/typesListar shared types.
GET/api/v2/types/:fullnameObtener shared type.
PUT/api/v2/types/:fullnameCrear o actualizar shared type.
DELETE/api/v2/types/:fullnameEliminar shared type.