Automation · Webhooks

Register a webhook endpoint

key required

post

https://api.et-forex.com/api/v1/webhooks

Returns the signing secret exactly once. Every delivery is signed with it, so store it now — recovering it requires a rotation. Leave bankCodes/currencyCodes empty to receive every rate change.

Request body

urlrequiredstring: HTTPS endpoint to POST events to. Must resolve to a publicly reachable address.
descriptionstring: Free-text label to help you tell endpoints apart.
bankCodesstring[]: Only deliver changes for these bank codes. Omit or leave empty for all banks.
currencyCodesstring[]: Only deliver changes for these currency codes. Omit or leave empty for all currencies.

Responses

201: Register a webhook endpoint
400: Invalid request — VALIDATION_ERROR.
401: Missing, invalid, revoked or expired credential.
403: Authenticated but not entitled — the plan does not include this endpoint or feature.
429: Rate limit or monthly quota exceeded — RATE_LIMIT_EXCEEDED or QUOTA_EXCEEDED. Honour Retry-After.
500: Unexpected server error.

curl 'https://api.et-forex.com/api/v1/webhooks' \
  -X POST \
  -H 'x-api-key: etf_live_your_key_here' \
  -H 'content-type: application/json' \
  -d '{"url":"https://example.com/hooks/et-forex","description":"Production trading desk","bankCodes":["CBE","AWASH"],"currencyCodes":["USD","EUR"]}'

Example response

{
  "success": true,
  "data": {
    "id": "string",
    "url": "https://example.com/hooks/et-forex",
    "description": "Production trading desk",
    "status": "ACTIVE",
    "bankCodes": [
      "CBE"
    ],
    "currencyCodes": [
      "USD"
    ],
    "consecutiveFailures": 0,
    "lastSuccessAt": "string",
    "lastFailureAt": "string",
    "lastFailureReason": "string",
    "createdAt": "string",
    "secret": "whsec_x7Kd2mQ..."
  },
  "meta": {
    "timestamp": "2026-07-09T12:00:00.000Z",
    "requestId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
  }
}

Not runnable from the browser. The API accepts cross-origin GET only, so a POST has to come from your own server. Copy a sample above and run it there.