Account ('campaigns_recipients_quota_reached')

The event is triggered when a business sends a campaign whose recipients exceed its remaining monthly campaign recipients quota.

This is one of the event types delivered by the pivot/event webhook. A single subscription to pivot/event delivers all of its event types — use the event field in the payload to tell them apart.

📘

Availability

This event is only sent for businesses whose directory has the campaign_recipient_quota_breached feature enabled. When it is enabled, exceeding the quota does not block the campaign from being sent — the event is sent as a notification instead. Contact your account manager to have it enabled.

Webhook authorization: using a directory token.

Subscribing to the pivot event webhook:

curl --location --request POST '/platform/v1/webhook/subscribe' \
--header 'Authorization: "Bearer API_TOKEN"'\
--header 'Content-Type: application/json' \
--data-raw '{
"event": "pivot/event",
"target_url": "URL"
}'

Campaign recipients quota reached payload example:

{
  "id": "123456789abcdefg",
  "event": "campaigns_recipients_quota_reached"
}