Automation · Webhooks

Update an endpoint’s URL, filters, or status

key required

patch

https://api.et-forex.com/api/v1/webhooks/{id}

Set status to PAUSED to stop delivery without losing the endpoint, or ACTIVE to resume — which also clears the failure streak.

Path parameters

idrequiredstring

Request body

urlstring
descriptionstring
status"ACTIVE" | "PAUSED": Set PAUSED to stop delivery without losing the endpoint. An endpoint we auto-disabled can be reactivated by setting ACTIVE.
bankCodesstring[]
currencyCodesstring[]

Responses

200: Update an endpoint’s URL, filters, or status
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.
404: No such resource, or it is not active — NOT_FOUND. The message names what was looked up.
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/ID' \
  -X PATCH \
  -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","status":"ACTIVE","bankCodes":["CBE"],"currencyCodes":["USD"]}'

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"
  },
  "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 PATCH has to come from your own server. Copy a sample above and run it there.