Webhooks

Change a webhook

Its url, label, notify_at or threshold, or pause and resume it (status). A new url is checked at once. Any other field is refused with a 400 that says where that change is made.

patch/webhooks/{id}

Request

  • Base URL: https://sochain.com/api/v3
  • URL: https://sochain.com/api/v3/webhooks/{id}
  • Auth: API key in header API-KEY

Path parameters

idstring required

The webhook's ID.

Request body

urlstring uri

A new endpoint: it's checked at once, and the webhook is unverified until it echoes the challenge.

status'active' | 'paused'

Pause it, or resume it (a webhook resumes once verified).

labelstring

Yours, as the dashboard shows it.

notify_atinteger[]

address.transaction and transaction.confirmation: as on create.

thresholdnumber

fees.below and fees.above: the fee rate to cross; the alert starts over.

Response

Success.

status'success' required

Changes

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