Set webhook endpoint

Sets the delivery endpoint for this key's environment — a test key writes the sandbox endpoint, a live key the live one, and neither can touch the other. Send an empty string to unset it. Useful for pointing a sandbox integration at an ephemeral tunnel from CI.

Authorization

apiKey

X-API-Key<token>

Your merchant API key, shown once at creation in the dashboard (Settings → API key).

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url*|

Where signed webhooks for THIS environment are delivered. Send an empty string to unset it — for a test key that reverts sandbox events to the live endpoint; for a live key it stops live delivery entirely. Must be a public http(s) URL: private, loopback, and link-local addresses are rejected.

Response Body

`application/json`

curl -X PATCH "https://example.com/webhooks/endpoint" \  -H "Content-Type: application/json" \  -d '{    "url": "https://example.com/webhooks/tidepay"  }'

{  "environment": "live",  "url": "string",  "effectiveUrl": "string"}

Set webhook endpoint

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`