alerts.fx_rate.triggered – Notification when an alert condition is metPOST /v1/alerts with condition parameters and expiration date.active_status: true).DELETE /v1/alerts/{id}, which sets active_status: false.valid_until date.alerts.fx_rate.triggered. More info: Notifications & Subscriptionsmetadata object contains the alert configuration and the triggering FX rate when applicable.| Field | Description |
|---|---|
currency_pair | Currency pair being monitored (e.g., usd/cop, usd/mxn) |
condition | Alert condition type: above, below, or within_range |
max_rate | Maximum rate threshold (used for above and within_range conditions) |
min_rate | Minimum rate threshold (used for below and within_range conditions) |
fx_rate | The actual FX rate that triggered the alert (only present in trigger notifications) |
fx_rate field is only included in alerts.fx_rate.triggered webhook payloads and represents the market rate at the moment the alert condition was met.current_rate > max_ratecondition: "above"max_rate: Numeric threshold{
"metadata": {
"condition": "above",
"currency_pair": "usd/cop",
"max_rate": 3500
}
}{
"type": "fx_rate",
"alias": "My Alert Name",
"metadata": {
"condition": "above|below|within_range",
"currency_pair": "usd/cop",
"max_rate": 3500,
"min_rate": 3400
},
"valid_until": "2026-12-31T23:59:59Z"
}| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | Must be "fx_rate" |
alias | string | No | Friendly name for the alert |
metadata.condition | string | Yes | One of: above, below, within_range |
metadata.currency_pair | string | Yes | Currency pair to monitor (e.g., usd/cop) |
metadata.max_rate | number | Conditional | Required for above and within_range |
metadata.min_rate | number | Conditional | Required for below and within_range |
valid_until | string | Yes | ISO 8601 timestamp - alert expiration date |
within_range conditions for opportunistic execution strategiesvalid_until dates to avoid stale alerts accumulatingevent_id to handle duplicate webhook deliveriesfx_rate value from triggered alerts for audit and decision-makingalias values to identify alerts across your teamupdated_at field to track when alerts were last modifiedevent_signature_key periodically{
"type": "fx_rate",
"alias": "Execute Payment Window",
"metadata": {
"condition": "below",
"currency_pair": "usd/cop",
"min_rate": 4000
},
"valid_until": "2026-06-30T23:59:59Z"
}fx_rate: 3985.50| Currency Pair | Description |
|---|---|
usd/cop | US Dollar to Colombian Peso |
cop/usd | Colombian Peso to US Dollar |
usd/mxn | US Dollar to Mexican Peso |
mxn/cop | Mexican Peso to Colombian Peso |
| HTTP Status | Error | Resolution |
|---|---|---|
400 Bad Request | Invalid condition type | Use above, below, or within_range |
400 Bad Request | Missing required rate fields | Include max_rate for above, min_rate for below, both for within_range |
400 Bad Request | Invalid currency pair | Use supported currency pairs only |
401 Unauthorized | Invalid authentication | Check your API credentials and authorization header |
404 Not Found | Alert ID does not exist | Verify the alert ID from your list of alerts |
422 Unprocessable Entity | Invalid valid_until date | Ensure date is in the future and properly formatted |
active_status: true and a unique alert ID.alerts.fx_rate.created receive an immediate notification.alerts.fx_rate.triggered./v1/alerts with your desired condition and currency pair.event_signature header and your subscription's event_signature_key.fx_rate value to decide whether to lock rates, execute payments, or adjust hedging strategies.