Docs
Api referenceWebhooks

Change a webhook endpoint

PATCH
/v1/webhooks/{id}

Change its url, events or description. The secret stays the same.

Authorization

apiKey
AuthorizationBearer <token>

Authorization: Bearer fx_live_<id>_<secret>.

A key is shown once, at creation. We cannot show it again or recover it for you. Keys carry a label (live or test) in the key itself, so each configuration is easy to tell apart. Both reach real brokers: test with a broker demo account.

Scopes are per key. A key without accounts:write can read accounts and nothing else.

In: header

Path Parameters

id*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Properties1 <= properties

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "url": "https://example.com/fxapis/webhooks",    "description": "Copier",    "events": [      "order.filled"    ],    "enabled": true,    "disabledAt": null,    "disabledReason": "20 deliveries in a row failed",    "consecutiveFailures": 0,    "secretHint": "whsec_…Qx4w",    "previousSecretExpiresAt": null,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}