๐ Get webhook
Code samples
GET /api/v1/webhooks/{webhook}
curl 'https://settla.net/api/v1/webhooks/1' \
-H 'X-API-Key: $SETTLA_API_KEY' \
-H 'Accept: application/json'
Returns a single webhook by id if it belongs to the authenticated user
๐ ๏ธ Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| webhook | path | integer | true | Webhook ID |
Example responses
200 Response
{
"data": {
"id": 1,
"user_id": 10,
"coin": "TRX",
"webhook_url": "https://example.com/webhook",
"addresses": [
"TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o"
],
"secret": "whsec_4f8c1a9d7e2b6035c4a1f8d9e0b3c7a25f6e1d4c8b0a9372e5d6c1f804b3a7e29",
"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 |
| 404 | Not Found | Webhook not found, or it belongs to another user | 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 |