Docs
Api referenceAlerts

Alerts a hook received, and what became of each

GET
/v1/alert-hooks/{id}/deliveries

Newest first, kept for 30 days. The first place to look when an alert did not trade: every alert that reached a hook is here — refused, ignored and duplicate ones included — with the reason in words.

A hook takes at most 30 alerts a minute; past that, one row records the refusal and the rest of that minute's alerts are not recorded.

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

Query Parameters

status?string

Value in

  • "pending"
  • "accepted"
  • "rejected"
  • "duplicate"
  • "ignored"
limit?integer
Range1 <= value <= 200
Default50
cursor?string

The previous page's nextCursor.

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/alert-hooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/deliveries"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "receivedAt": "2019-08-24T14:15:22Z",      "status": "pending",      "reason": null,      "action": "buy",      "symbol": "XAUUSD.a",      "payload": null,      "orderIds": [        "0757681a-ae10-48a2-bd84-b9b12b1ec0fb"      ],      "waveId": null,      "completedAt": null    }  ],  "page": {    "hasMore": true,    "nextCursor": null  }}