👨‍🔁 Update webhook

Code samples

PUT /api/v1/webhooks/{webhook}

curl -X PUT 'https://settla.net/api/v1/webhooks/1' \
  -H 'X-API-Key: $SETTLA_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "coin": "TRX",
  "webhook_url": "https://example.com/webhook",
  "addresses": [
    "TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o"
  ],
  "is_active": true
}'

Updates a webhook that belongs to the authenticated user. All of coin, webhook_url and addresses are required — the request replaces the subscription rather than patching it, so an omitted address list is an error, not "keep the current one".

Use this call to switch a webhook back on after the delivery circuit breaker has disabled it.

Body parameter

{
  "coin": "TRX",
  "webhook_url": "https://example.com/webhook",
  "addresses": [
    "TLWKepDBC8RZjAhtWyNqASyzgyVyHUuS7o"
  ],
  "is_active": true
}

🛠️ Parameters

Name	In	Type	Required	Description
webhook	path	integer	true	Webhook ID
body	body	object	true	none
» coin	body	string	true	none
» webhook_url	body	string(uri)	true	Must be a publicly reachable http/https address; private and loopback destinations are rejected with 422.
» addresses	body	[string]	true	The complete list of addresses to monitor. The update replaces the stored list instead of merging into it, so send the addresses that are not changing as well. Same rules as on create: at least one entry, 255 characters per entry, exact-string matching, lower-case for ETH.
» is_active	body	boolean	false	none

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"
  }
}

422 Response

{
  "errors": {}
}

🔁 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
422	Unprocessable Entity	Validation failed	Inline

🔄 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

Status Code 422

Name	Type	Required	Restrictions	Description
» errors	object	false	none	Field name → list of messages.

Enumerated Values

Property	Value
coin	TRX
coin	BTC
coin	ETH