Sign in

v3

latestOpenAPI 3.1.02026-07-31144319609.5 KB
Webhook

Webhook: project.budget_notification

This webhook is triggered when a project or subproject's budget usage crosses a defined threshold.

Triggering Conditions:

  • The project/subproject must have budget notification thresholds configured (e.g., 50%, 60%, 70%)
  • The current budget usage percentage must exceed a threshold that wasn't previously exceeded
  • The webhook only fires once per threshold level (prevents duplicate notifications)
  • The company must have a Trial or Enterprise subscription

Example Scenarios:

  • Usage increases from 45% to 55% with a 50% threshold → webhook fires for 50%
  • Usage increases from 55% to 60% with only a 50% threshold → webhook does NOT fire (already exceeded)
  • Usage increases from 55% to 80% with thresholds at 50% and 75% → webhook fires for 75%

The type field in the payload indicates whether it's a projectBudget or subprojectBudget notification. The threshold field contains the percentage value that was exceeded.

postWebhookproject_budget_notification

Payload

subscription_idinteger required

The ID of the webhook subscription

company_idinteger required

The ID of the company

occurred_atstring date-time required

The timestamp when the event occurred (ISO 8601 format)

event_name'project.budget_notification' required

The name of the webhook event

tokenstring required

The webhook verification token

Example payload

{
  "subscription_id": 42,
  "company_id": 1337,
  "occurred_at": "1986-05-10T17:02:00Z",
  "payload": {
    "id": 123,
    "type": "projectBudget",
    "threshold": 80
  },
  "token": "My_Sup3r_T0k3n"
}

Response

Return a 200 status to indicate that the data was received successfully