👨‍📜 List webhooks

Code samples

GET /api/v1/webhooks

curl 'https://settla.net/api/v1/webhooks' \
  -H 'X-API-Key: $SETTLA_API_KEY' \
  -H 'Accept: application/json'

Returns all webhooks belonging to the authenticated user.

Note the path: webhooks are NOT scoped to a coin. One endpoint serves TRX, BTC and ETH subscriptions; the coin is a field of the webhook.

These endpoints only manage subscriptions. The format of the notifications themselves, the matching rules per chain, retries and idempotency are described on the "Receiving notifications" page.

Example responses

200 Response

{
  "data": [
    {
      "id": 1,
      "user_id": 10,
      "coin": "TRX",
      "webhook_url": "https://example.com/webhook",
      "addresses": [
        "TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o"
      ],
      "is_active": 1,
      "last_triggered_at": null,
      "deleted_at": null,
      "created_at": "2025-09-16T12:00:00.000000Z",
      "updated_at": "2025-09-16T12:00:00.000000Z"
    }
  ]
}

🔁 Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
401	401	Missing or invalid API key	None

🔄 Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» data	[object]	false	none	none
»» id	integer	false	none	none
»» user_id	integer	false	none	none
»» coin	string	false	none	none
»» webhook_url	string(uri)	false	none	none
»» addresses	[string]	false	none	none
»» secret	string	false	none	Key the platform signs deliveries with. The whole string, `whsec_` prefix included, is the HMAC-SHA256 key; the signed message is `<X-Settla-Timestamp>.<raw body>`. Created together with the webhook and returned by every endpoint here — see the Receiving notifications page for verification code. Rotate it with `POST /api/v1/webhooks/{webhook}/secret`.
»» is_active	[oneOf]	false	none	Whether the webhook receives notifications. Beware of the type: this field is not normalised in API v1, so it comes back as the raw database value 0 or 1 — except in the response to a create request, which echoes the boolean you have just sent. Treat it as truthy rather than comparing it to `true`.
»» last_triggered_at	string(date-time)¦null	false	none	Reserved for the time of the last notification. Nothing writes it at the moment, so it is always null — do not use it to tell a live webhook from an idle one. The dashboard's webhook statistics show the actual delivery history.
»» deleted_at	string(date-time)¦null	false	none	Always null in responses; deleted webhooks are not returned.
»» created_at	string(date-time)	false	none	none
»» updated_at	string(date-time)	false	none	none

Enumerated Values

Property	Value
coin	TRX
coin	BTC
coin	ETH