0X0xinsider
Webhooks

Update a builder webhook destination

Changed on

Updates name, HTTPS URL, event types, or enabled state. URL changes force pending_verification and return a new verification token; the new destination must answer 2xx to the signed webhook.verification challenge before deliveries resume. A URL change returns 409 with error.reason=webhook_delivery_in_progress while this destination has an active delivery; retry the same mutation after that request completes.

patch/api/v1/webhooks/{id}

Request

Path parameters

idinteger required

Webhook endpoint id owned by the authenticated API key user.

Headers

X-Query-Validation'strict'

Opt into strict query-name validation. The default is compatible: unknown names are ignored and reported in X-Query-Ignored. With strict, an unknown name returns 400 bad_request with error.reason unknown_query_parameter before the handler runs, including when its percent escape is incomplete.

Idempotency-Keystring

Optional safe-retry key. Reuse the same value only when retrying the exact same mutation request body; a different body returns 422 and an in-flight matching request returns 409.

Request body

namestring
urlstring uri

Replacement public HTTPS callback URL on the default port 443, validated and checked for uniqueness exactly like the create url. HTTPS scheme/host case, trailing DNS dots and port 443 normalize; path/query case is preserved. Changing it resets status to pending_verification and returns a new verification token; the new destination must pass the verification challenge before deliveries resume.

event_typesWebhookEventType[]
enabledboolean

Response

Webhook destination

object'webhook' required

Changes

  • 0c2767401065Revision changes
    • warning

      added the new large_trade_inserted_v2 enum value to the // response property for the response status

    • info

      added the new optional request property

    • info

      added the new large_trade_inserted_v2 enum value to the request property /

    • info

      added the required property / to the response with the status

  • 7e57bd9dc8b5Revision changes
    • warning

      added the new sharp_money_flow_detected enum value to the // response property for the response status

    • info

      added the new sharp_money_flow_detected enum value to the request property /