Api referenceWebhooks
Enable a webhook endpoint
Events are sent again from the next one, and the failure count starts from zero. Events already queued to it before it was switched off can be redelivered from the delivery log; events recorded while it was off never reached that log and can't be redelivered. Safe to repeat.
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
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/enable"{ "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" }}