keys-hooks

Register a completion webhook

Get called on DONE/FAILED for a route id instead of polling. We POST {event,routeId,status,destTx,srcTx,ts}. If secret is set, deliveries carry x-anygas-signature: sha256=HMAC(secret, rawBody). Watch state at GET /api/hooks/{id}. Rate limit 120/min.

post/api/hooks/register

Request

Base URL: https://api.anygas.xyz/svc
URL: https://api.anygas.xyz/svc/api/hooks/register
Auth: none declared

Request body

routeIdstring required

urlstring required

secretstring

Example request

{
  "routeId": "rt_abc123",
  "url": "https://example.com/webhook"
}

Response

Hook registered

idstring

routeIdstring

urlstring

statusstring

notestring

Example response

{
  "id": "wh_1008e656e4d46f7aec",
  "routeId": "rt_abc123",
  "url": "https://example.com/webhook",
  "status": "pending"
}

Changes

No recorded changes to this operation across all 1 revision of this API.