Register a webhook endpoint
POST
/api/v1/webhooks
const url = 'https://trongas.ai/api/v1/webhooks';const options = { method: 'POST', headers: {'X-Api-Key': '<X-Api-Key>', 'Content-Type': 'application/json'}, body: '{"url":"example","events":["example"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://trongas.ai/api/v1/webhooks \ --header 'Content-Type: application/json' \ --header 'X-Api-Key: <X-Api-Key>' \ --data '{ "url": "example", "events": [ "example" ] }'Required API-key scope: full
Subscribe an HTTPS URL to the events you pick, so you learn about orders settling, deposits crediting and rules pausing without polling.
The response includes the signing secret — it is shown once and never again. Store it now; if you lose it, rotate.
Use the secret to verify the X-TronGas-Signature header on every delivery.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
url
required
string
events
required
Array<string> | null
Examplegenerated
{ "url": "example", "events": [ "example" ]}object
url
required
string
events
required
Array<string> | null
Examplegenerated
{ "url": "example", "events": [ "example" ]}object
url
required
string
events
required
Array<string> | null
Examplegenerated
{ "url": "example", "events": [ "example" ]}Responses
Section titled “Responses”OK
object
endpoint
required
object
id
required
string format: uuid
url
required
string
events
required
string
enabled
required
boolean
lastStatus
required
null | string
lastDeliveryAt
required
null | string format: date-time
createdAt
required
string format: date-time
secret
required
string
object
endpoint
required
object
id
required
string format: uuid
url
required
string
events
required
string
enabled
required
boolean
lastStatus
required
null | string
lastDeliveryAt
required
null | string format: date-time
createdAt
required
string format: date-time
secret
required
string
Examplegenerated
{ "endpoint": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "url": "example", "events": "example", "enabled": true, "lastStatus": "example", "lastDeliveryAt": "2026-04-15T12:00:00Z", "createdAt": "2026-04-15T12:00:00Z" }, "secret": "example"}object
endpoint
required
object
id
required
string format: uuid
url
required
string
events
required
string
enabled
required
boolean
lastStatus
required
null | string
lastDeliveryAt
required
null | string format: date-time
createdAt
required
string format: date-time
secret
required
string
Examplegenerated
{ "endpoint": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "url": "example", "events": "example", "enabled": true, "lastStatus": "example", "lastDeliveryAt": "2026-04-15T12:00:00Z", "createdAt": "2026-04-15T12:00:00Z" }, "secret": "example"}