This article will cover the following:
Use the Notifications & Alerts API to programmatically create, retrieve, and manage performance alerts — enabling automated monitoring of caps, conversion rates, and traffic anomalies without manual dashboard review.
api_key parameter. Find yours under Setup → System Access → API Keys.Overview
CAKE's notification and alert system allows network administrators to define threshold-based triggers that fire when specific performance conditions are met. Alerts can monitor conversion caps, click volumes, conversion rates, payout totals, and other key metrics across offers, affiliates, or the entire network.
When an alert threshold is breached, CAKE sends a notification to the configured recipients via email. Alerts are particularly valuable for cap management — you can be notified when an offer is approaching its daily conversion limit, giving you time to adjust caps or add budget before the offer stops serving.
Alerts are configured in the CAKE UI under Setup → Alerts. The API exposes endpoints for retrieving existing alert configurations and creating new ones programmatically — useful for networks that want to enforce alert standards across all offers or automate alert setup during offer onboarding.
Key Concepts
- Alert — A configured threshold rule in CAKE that triggers a notification when a performance metric crosses a defined value. Alerts monitor metrics like clicks, conversions, payouts, and cap utilization.
- Alert Type — The metric category an alert monitors. Common types include Conversion Cap, Click Cap, Conversion Rate, Payout Total, and Revenue Total.
- Alert Threshold — The numeric value that, when crossed, triggers the alert notification. Can be set as an absolute number or a percentage of a cap.
- Alert Recipients — The email addresses that receive the notification when an alert fires. Multiple recipients can be configured per alert.
- Notification Frequency — How often CAKE sends alert notifications while the triggering condition persists — for example, once per hour or once per day.
- Alert Status — Controls whether an alert is actively evaluated. Active alerts are checked on every data update cycle; inactive alerts are skipped.
Available Actions
Get Alerts
/api/2/alerts.json| Parameter | Type | Required | Description |
|---|---|---|---|
| api_key | string | Yes | Your CAKE API key. |
| alert_id | integer | No | Filter to a single alert by its CAKE ID. |
| offer_id | integer | No | Filter alerts associated with a specific offer. |
| alert_status | string | No | Filter by status: active, inactive. |
| start_at_row | integer | No | Pagination offset. Default 0. |
| row_limit | integer | No | Max records. Default 100, max 500. |
Sample request
GET https://yourdomain.cakemarketing.com/api/2/alerts.json?api_key=YOUR_API_KEY&offer_id=1042&alert_status=activeSample response
{
"request_status": "Success",
"response": {
"alerts": [
{
"alert_id": 77,
"alert_name": "Daily Cap Warning - QuickLoans CPA",
"offer_id": 1042,
"alert_type": "Conversion Cap",
"threshold": 90,
"threshold_type": "percentage",
"recipients": ["ops@yournetwork.com"],
"alert_status": "active"
}
],
"total_rows": 1
}
}Create Alert
/api/2/alert.json| Parameter | Type | Required | Description |
|---|---|---|---|
| api_key | string | Yes | Your CAKE API key. |
| alert_name | string | Yes | Descriptive name for the alert. |
| offer_id | integer | No | The offer to monitor. Omit to create a network-level alert. |
| affiliate_id | integer | No | The affiliate to monitor (optional, for affiliate-level alerts). |
| alert_type | string | Yes | The metric to monitor: conversion_cap, click_cap, conversion_rate, payout_total. |
| threshold | decimal | Yes | The numeric value that triggers the alert. |
| threshold_type | string | No | absolute or percentage. Default: absolute. |
| recipients | string | Yes | Comma-separated list of email addresses to notify when the alert fires. |
| alert_status | string | No | active | inactive. Default: active. |
Sample request
POST https://yourdomain.cakemarketing.com/api/2/alert.json
{
"api_key": "YOUR_API_KEY",
"alert_name": "Daily Cap Warning - QuickLoans CPA",
"offer_id": 1042,
"alert_type": "conversion_cap",
"threshold": 90,
"threshold_type": "percentage",
"recipients": "ops@yournetwork.com,am@yournetwork.com",
"alert_status": "active"
}Sample response
{
"request_status": "Success",
"response": {
"alert_id": 78,
"alert_name": "Daily Cap Warning - QuickLoans CPA",
"offer_id": 1042,
"alert_status": "active",
"created_date": "2026-06-19T10:30:00Z"
}
}Update Alert
/api/2/update_alert.json| Parameter | Type | Required | Description |
|---|---|---|---|
| api_key | string | Yes | Your CAKE API key. |
| alert_id | integer | Yes | The ID of the alert to update. |
| alert_name | string | No | Updated alert name. |
| threshold | decimal | No | Updated trigger threshold. |
| recipients | string | No | Updated comma-separated recipient email list. |
| alert_status | string | No | active | inactive |
Sample request
POST https://yourdomain.cakemarketing.com/api/2/update_alert.json
{
"api_key": "YOUR_API_KEY",
"alert_id": 77,
"threshold": 80,
"recipients": "ops@yournetwork.com",
"alert_status": "active"
}Sample response
{
"request_status": "Success",
"response": {
"alert_id": 77,
"threshold": 80,
"alert_status": "active"
}
}You may also be interested in:
If you have any questions, please reach out to your dedicated CAKE Client Success Manager/Account Manager or contact the CAKE Support Team at support@getCAKE.com.