Update Webhook

patch

https://api.preczn.com/v1/webhooks/{webhookId}

Path Params

webhookId

string

required

Body Params

endpointUrl

string

required

The endpoint that receives webhook events. Must be a well-formed URL.

active

boolean

Whether the subscription is active and will receive events. Must be a JSON boolean, not the string "true".

httpHeaderKey

string

Name of a custom HTTP header sent with every webhook call, used together with httpHeaderValue. Letters, digits, whitespace, and the characters - + : ; * , . & / = " % ( ) only.

description

string

Free-text description of the subscription. Content is currently unrestricted (reserved for future tightening).

httpHeaderValue

string

Value sent in the custom HTTP header named by httpHeaderKey. Content is currently unrestricted (reserved for future tightening).

events

array of strings

required

List of webhook events to subscribe to

events*

Headers

idempotency-key

string

Unique key to ensure idempotency of requests. If provided, the server will return the same response for subsequent requests with the same key.

Responses

400

Invalid request body.

401

Invalid API key.

500

Unable to service request due to server-side error. Please reattempt request.

201Webhook updated successfully.