Budget Tracker Webhook Payload

When Budget Webhooks Are Triggered

Budget tracker webhooks are designed to keep you informed about important changes to your budget status without overwhelming you with constant notifications. Understanding when and why these webhooks are triggered will help you set up the most effective notification strategy for your needs.

Trigger Events

Budget webhooks are triggered when your budget status changes between the three main states:

• On Track (Green): Spending is within acceptable parameters
• Warning (Yellow): Spending is drifting outside acceptable range but not yet critical
• Critical (Red): Spending requires immediate attention

Smart Notification Strategy

Instead of receiving a webhook every time your budget data updates (which could be multiple times per day), webhooks are only sent when there's a status change. This approach provides several benefits:

Reduced Notification Fatigue: You only receive alerts when something meaningful happens with your budget, not for routine data updates.

Actionable Alerts: Each webhook represents a change that may require your attention or action, making every notification relevant.

Selective Monitoring: You can choose which status changes are important to you. For example:

• Monitor only "Critical" changes for urgent intervention
• Track "Warning" and "Critical" for proactive budget management
• Subscribe to "Any Change" for complete visibility

Practical Use Cases

Agency Management: Set up Critical-only notifications for client budgets to immediately know when intervention is needed.

Campaign Optimization: Use Warning notifications to proactively adjust spending before budgets become critical.

Reporting Systems: Configure "Any Change" notifications to automatically update external dashboards or send client reports.

Custom Workflows: Use webhook data with automation tools like Zapier or Make to trigger custom workflows when budget statuses change.

‍

Payload details for Budgets:

<fieldName>clicks<fieldName> <fieldType>string<fieldType>
Allocated funds for generating a specific number of clicks in a digital marketing campaign

<fieldName>impressions<fieldName> <fieldType>string<fieldType>
Allocated funds for online ad displays and visibility

<fieldName>conversions<fieldName> <fieldType>string<fieldType>
Allocated funds for achieving desired actions or conversions in a marketing campaign

<fieldName>allConversions<fieldName> <fieldType>string<fieldType>
Allocated funds for generating a specific number of desired actions or conversions in a marketing campaign

<fieldName>device<fieldName> <fieldType>enum<fieldType> <fieldDescription>(Possible enum values: DESKTOP, MOBILE, TABLET)<fieldDescription>
Devices used to monitor and control expenses

<fieldName>adNetworkType<fieldName> <fieldType>enum<fieldType> <fieldDescription>(Possible enum values: SEARCH, SEARCH_PARTNERS)<fieldDescription>
Budget allocated for a specific type of advertising network or platform in a marketing campaign

<fieldName>spendPercent<fieldName> <fieldType>string<fieldType>
The percentage you have spent compared to your target

<fieldName>periodAverageSpend<fieldName> <fieldType>string<fieldType>
The average amount of budget spent over a specific period of time in a marketing campaign

<fieldName>estimated<fieldName> <fieldType>string<fieldType>
The projected or anticipated amount of budget allocated for a marketing campaign based on estimations

<fieldName>estimatedPercent<fieldName> <fieldType>string<fieldType>
Budget Estimate compared to your target as a percentage

<fieldName>pacing<fieldName> <fieldType>string<fieldType>
The amount you are above or below the target for the period to date

<fieldName>pacingDirection<fieldName> <fieldType>string<fieldType>
Value showing if your period to date pacing is above or below your target

<fieldName>dailyTargetAverage<fieldName> <fieldType>string<fieldType>
The average target amount of budget to be spent per day in a marketing campaign

<fieldName>daysElapsed<fieldName> <fieldType>string<fieldType>
The amount of days so far in the current budget period

<fieldName>daysRemaining<fieldName> <fieldType>string<fieldType>
The amount of days remaining in the current budget period

<fieldName>dateStart<fieldName> <fieldType>string<fieldType>
Date of the start of the reporting period

<fieldName>dateEnd<fieldName> <fieldType>string<fieldType>
Date of the end of the reporting period

<fieldName>graphDataSeries<fieldName> <fieldType>string<fieldType>
Data series representing the allocation and distribution of budget over time in a graphical representation

• <fieldName>spend<fieldName> <fieldType>string<fieldType>The expenditure or spending data series represented in a graphical representation of the budget over time
• <fieldName>estimated<fieldName> <fieldType>string<fieldType>The projected or anticipated data series representing the estimated budget values in a graphical representation over time
• <fieldName>targetRange<fieldName> <fieldType>string<fieldType>The range of target values represented in a graphical representation of the budget over time
• <fieldName>spendAverage<fieldName> <fieldType>string<fieldType>The average spending values represented in a graphical representation of the budget over time

<fieldName>graphDataCumulative<fieldName> <fieldType>enum<fieldType>
The cumulative data represented in a graphical representation of the budget over time‍

• <fieldName>spend<fieldName> <fieldType>string<fieldType>The cumulative spending data represented in a graphical representation of the budget over time
• <fieldName>estimated<fieldName> <fieldType>string<fieldType>The cumulative estimated data represented in a graphical representation of the budget over time
• <fieldName>targetRange<fieldName> <fieldType>string<fieldType>The cumulative target range data represented in a graphical representation of the budget over time

<fieldName>spend<fieldName> <fieldType>string<fieldType>
The amount you have spent

<fieldName>status<fieldName> <fieldType>string<fieldType>
Value of the Budget Status (On Track, Warning, Critical)

<fieldName>currency<fieldName> <fieldType>string<fieldType>
Text of the currency used in the Budget

<fieldName>budgetId<fieldName> <fieldType>string<fieldType>
A 16 character alphanumeric System defined ID

<fieldName>budgetname<fieldName> <fieldType>string<fieldType>
Auto generated name or custom name given to the Budget

<fieldName>accountId<fieldName> <fieldType>string<fieldType>
A 16 character alphanumeric System defined ID

<fieldName>clientId<fieldName> <fieldType>string<fieldType>
A 16 character alphanumeric System defined ID

<fieldName>clientName<fieldName> <fieldType>string<fieldType>
Client Name

<fieldName>chartImage<fieldName> <fieldType>string<fieldType>
Image of the Jepto Chart

‍

Sample Budget Webhook URL Payload:

{
  "accountId": "d83f96d935794050",
  "budgetId": "0357637b6f2c4902",
  "budgetName": "Sample Budget",
  "clientName": "Cremin Inc.",
  "clientId": "fb21bb814cac49a5",
  "clicks": 24,
  "impressions": 118,
  "conversions": 1,
  "allConversions": 1,
  "device": [
    "DESKTOP",
    "MOBILE"
  ],
  "adNetworkType": [
    "SEARCH"
  ],
  "spendPercent": "2986.00",
  "periodAverageSpend": "4.27",
  "estimated": "127.97",
  "estimatedPercent": "6398.57",
  "pacing": "6298.57",
  "pacingDirection": "ABOVE",
  "dailyTargetAverage": "Over Budget",
  "daysElapsed": 14,
  "daysRemaining": 15,
  "dateStart": "2022-09-01",
  "dateEnd": "2022-09-30",
  "graphDataSeries": {
    "spend": {
      "2022-09-01": 0,
      "2022-09-02": 1.29,
      "2022-09-03": 1.56,
      "2022-09-04": 0,
      "2022-09-05": 0.07,
      "2022-09-06": 9.03,
      "2022-09-07": 9.85,
      "2022-09-08": 9.53,
      "2022-09-09": 7.95,
      "2022-09-10": 4.99,
      "2022-09-11": 1.22,
      "2022-09-12": 0.01,
      "2022-09-13": 4.27,
      "2022-09-14": 9.95
    },
    "estimated": {
      "2022-09-14": 4.27,
      "2022-09-15": 4.27,
      "2022-09-16": 4.27,
      "2022-09-17": 4.27,
      "2022-09-18": 4.27,
      "2022-09-19": 4.27,
      "2022-09-20": 4.27,
      "2022-09-21": 4.27,
      "2022-09-22": 4.27,
      "2022-09-23": 4.27,
      "2022-09-24": 4.27,
      "2022-09-25": 4.27,
      "2022-09-26": 4.27,
      "2022-09-27": 4.27,
      "2022-09-28": 4.27,
      "2022-09-29": 4.27,
      "2022-09-30": 4.27
    },
    "targetRange": {
      "2022-09-01": [
        0.09,
        0.04
      ],
      "2022-09-02": [
        0.09,
        0.04
      ],
      "2022-09-03": [
        0.09,
        0.04
      ],
      "2022-09-04": [
        0.09,
        0.04
      ],
      "2022-09-05": [
        0.09,
        0.04
      ],
      "2022-09-06": [
        0.09,
        0.04
      ],
      "2022-09-07": [
        0.09,
        0.04
      ],
      "2022-09-08": [
        0.09,
        0.05
      ],
      "2022-09-09": [
        0.09,
        0.05
      ],
      "2022-09-10": [
        0.09,
        0.05
      ],
      "2022-09-11": [
        0.09,
        0.05
      ],
      "2022-09-12": [
        0.08,
        0.05
      ],
      "2022-09-13": [
        0.08,
        0.05
      ],
      "2022-09-14": [
        0.08,
        0.05
      ],
      "2022-09-15": [
        0.08,
        0.05
      ],
      "2022-09-16": [
        0.08,
        0.05
      ],
      "2022-09-17": [
        0.08,
        0.05
      ],
      "2022-09-18": [
        0.08,
        0.05
      ],
      "2022-09-19": [
        0.08,
        0.05
      ],
      "2022-09-20": [
        0.08,
        0.06
      ],
      "2022-09-21": [
        0.08,
        0.06
      ],
      "2022-09-22": [
        0.08,
        0.06
      ],
      "2022-09-23": [
        0.08,
        0.06
      ],
      "2022-09-24": [
        0.07,
        0.06
      ],
      "2022-09-25": [
        0.07,
        0.06
      ],
      "2022-09-26": [
        0.07,
        0.06
      ],
      "2022-09-27": [
        0.07,
        0.06
      ],
      "2022-09-28": [
        0.07,
        0.06
      ],
      "2022-09-29": [
        0.07,
        0.06
      ],
      "2022-09-30": [
        0.07,
        0.06
      ]
    },
    "spendAverage": {
      "2022-09-01": 0,
      "2022-09-02": 0.65,
      "2022-09-03": 0.95,
      "2022-09-04": 0.71,
      "2022-09-05": 0.58,
      "2022-09-06": 1.99,
      "2022-09-07": 3.11,
      "2022-09-08": 3.92,
      "2022-09-09": 4.36,
      "2022-09-10": 4.43,
      "2022-09-11": 4.14,
      "2022-09-12": 3.79,
      "2022-09-13": 3.83,
      "2022-09-14": 4.27
    }
  },
  "graphDataCumulative": {
    "spend": {
      "2022-09-01": 0,
      "2022-09-02": 1.29,
      "2022-09-03": 2.85,
      "2022-09-04": 2.85,
      "2022-09-05": 2.92,
      "2022-09-06": 11.95,
      "2022-09-07": 21.8,
      "2022-09-08": 31.33,
      "2022-09-09": 39.28,
      "2022-09-10": 44.27,
      "2022-09-11": 45.49,
      "2022-09-12": 45.5,
      "2022-09-13": 49.77,
      "2022-09-14": 59.72
    },
    "estimated": {
      "2022-09-14": 59.72,
      "2022-09-15": 63.99,
      "2022-09-16": 68.25,
      "2022-09-17": 72.52,
      "2022-09-18": 76.78,
      "2022-09-19": 81.05,
      "2022-09-20": 85.31,
      "2022-09-21": 89.58,
      "2022-09-22": 93.85,
      "2022-09-23": 98.11,
      "2022-09-24": 102.38,
      "2022-09-25": 106.64,
      "2022-09-26": 110.91,
      "2022-09-27": 115.17,
      "2022-09-28": 119.44,
      "2022-09-29": 123.71,
      "2022-09-30": 127.97
    },
    "targetRange": {
      "2022-09-01": [
        0.09,
        0.04
      ],
      "2022-09-02": [
        0.19,
        0.08
      ],
      "2022-09-03": [
        0.28,
        0.12
      ],
      "2022-09-04": [
        0.36,
        0.17
      ],
      "2022-09-05": [
        0.45,
        0.22
      ],
      "2022-09-06": [
        0.54,
        0.26
      ],
      "2022-09-07": [
        0.62,
        0.31
      ],
      "2022-09-08": [
        0.7,
        0.37
      ],
      "2022-09-09": [
        0.78,
        0.42
      ],
      "2022-09-10": [
        0.86,
        0.47
      ],
      "2022-09-11": [
        0.94,
        0.53
      ],
      "2022-09-12": [
        1.01,
        0.59
      ],
      "2022-09-13": [
        1.09,
        0.65
      ],
      "2022-09-14": [
        1.16,
        0.71
      ],
      "2022-09-15": [
        1.23,
        0.77
      ],
      "2022-09-16": [
        1.3,
        0.83
      ],
      "2022-09-17": [
        1.37,
        0.9
      ],
      "2022-09-18": [
        1.43,
        0.97
      ],
      "2022-09-19": [
        1.5,
        1.04
      ],
      "2022-09-20": [
        1.56,
        1.11
      ],
      "2022-09-21": [
        1.62,
        1.18
      ],
      "2022-09-22": [
        1.68,
        1.25
      ],
      "2022-09-23": [
        1.74,
        1.33
      ],
      "2022-09-24": [
        1.8,
        1.4
      ],
      "2022-09-25": [
        1.85,
        1.48
      ],
      "2022-09-26": [
        1.9,
        1.56
      ],
      "2022-09-27": [
        1.96,
        1.64
      ],
      "2022-09-28": [
        2.01,
        1.73
      ],
      "2022-09-29": [
        2.05,
        1.81
      ],
      "2022-09-30": [
        2.1,
        1.9
      ]
    }
  },
  "spend": "59.72",
  "status": "CRITICAL",
  "currency": "AUD",
  "chartImage": "https://app.jepto.com/account/d83f96d935794050/client/fb21bb814cac49a5/budget/0357637b6f2c4902/graph/2022-03-10T04:22:32.515265Z.png"
}