Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

TOP Group (The Open Platform)

TOP Group (The Open Platform) Webhooks API

The Webhooks API from TOP Group (The Open Platform) — 15 operation(s) for webhooks.

Documentation Provider Profile APIs.io OpenAPI GitHub

TOP Group (The Open Platform) Webhooks API is one of 23 APIs that TOP Group (The Open Platform) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhooks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 16 operations across 15 paths, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

Requests are made against 3 base URLs: https://tonapi.io, https://testnet.tonapi.io, http://localhost:8081.

16 operations 15 paths 4 schemas 1 DELETE4 GET11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Base URL
https://tonapi.io
Contact
Support
Resource Areas
1

Paths & Operations 16

Across 15 paths, the API surfaces 16 operations — 1 DELETE, 4 GET, 11 POST. Each is listed below with its method, path, parameters, and response codes.

Webhooks 16
GET
/webhooks
Get list of webhooks
getWebhooks 1 param → 200default
POST
/webhooks
createWebhook 1 param body → 200default
DELETE
/webhooks/{webhook_id}
remove webhook and its subscriptions
deleteWebhook 2 params → 200default
POST
/webhooks/{webhook_id}/generate-new-token
generate a new secret token which will be used by TONAPI to authenticate itself when sending notifications to the webhook endpoint. The old token will be invalidated.
webhookGenerateNewToken 2 params → 200default
POST
/webhooks/{webhook_id}/back-online
Let TONAPI know that webhook is ready to receive notifications after it has been unavailable
webhookBackOnline 2 params → 200default
GET
/webhooks/{webhook_id}/logs
Get logs of failed attempts to deliver notifications to the webhook
getFailureLogs 3 params → 200default
POST
/webhooks/{webhook_id}/account-tx/subscribe
subscribe to notifications for a particular set of accounts
webhookAccountTxSubscribe 2 params body → 200default
POST
/webhooks/{webhook_id}/account-tx/unsubscribe
webhookAccountTxUnsubscribe 2 params body → 200default
GET
/webhooks/{webhook_id}/account-tx/subscriptions
webhookAccountTxSubscriptions 4 params → 200default
GET
/webhooks/{webhook_id}/msg-opcode/subscriptions
webhookNewContractsSubscriptions 4 params → 200default
POST
/webhooks/{webhook_id}/subscribe-new-contracts
receive a notification when a new contract is deployed to the blockchain
webhookNewContractSubscribe 2 params → 200default
POST
/webhooks/{webhook_id}/unsubscribe-new-contracts
receive a notification when a new contract is deployed to the blockchain
webhookNewContractUnsubscribe 2 params → 200default
POST
/webhooks/{webhook_id}/subscribe-msg-opcode/{opcode}
receive a notification when there is a new message with a given opcode
webhookMsgOpcodeSubscribe 3 params → 200default
POST
/webhooks/{webhook_id}/unsubscribe-msg-opcode/{opcode}
stop receiving a notification about a new message with a given opcode
webhookMsgOpcodeUnsubscribe 3 params → 200default
POST
/webhooks/{webhook_id}/mempool/subscribe
subscribe to notifications for mempool messages
webhookMempoolSubscribe 2 params → 200default
POST
/webhooks/{webhook_id}/mempool/unsubscribe
webhookMempoolUnsubscribe 2 params → 200default

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are WebhookLogs (2 properties), WebhookList (1 property), WebhookMsgOpcodeSubscriptions (1 property), WebhookAccountTxSubscriptions (1 property). Each schema is shown below with its type and property counts.

WebhookLogs
object
2 properties 1 required
WebhookAccountTxSubscriptions
object
1 property 1 required
WebhookMsgOpcodeSubscriptions
object
1 property 1 required
WebhookList
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

top-group-webhooks-api-openapi.yml Raw ↑

Other APIs TOP Group (The Open Platform) publishes across the network.

TOP Group (The Open Platform) Accounts API
AE Profile APIs.io
TOP Group (The Open Platform) Blockchain API
AE Profile APIs.io
TOP Group (The Open Platform) Connect API
AE Profile APIs.io
TOP Group (The Open Platform) DNS API
AE Profile APIs.io
TOP Group (The Open Platform) Emulation API
AE Profile APIs.io
TOP Group (The Open Platform) Events API
AE Profile APIs.io
TOP Group (The Open Platform) ExtraCurrency API
AE Profile APIs.io
TOP Group (The Open Platform) Gasless API
AE Profile APIs.io
TOP Group (The Open Platform) Jettons API
AE Profile APIs.io
TOP Group (The Open Platform) Lite Server API
AE Profile APIs.io
TOP Group (The Open Platform) Migration API
AE Profile APIs.io
TOP Group (The Open Platform) Multisig API
AE Profile APIs.io
#Webhooks
← Back to T APIs
API Details
ID
top-group:top-group-webhooks-api
Base URL
https://tonapi.io
Docs
https://tonapi.io
Provider
TOP Group (The Open Platform)
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network