Build audiences
Webhooks
Get notified when a customer enters or leaves a segment.
Every time a customer enters or leaves a segment, BreezeIQ can POST it to your endpoint. Use webhooks to send reminders or tag customers in your CRM the moment they qualify.
Choose what is sent#
Each segment's automations decide which changes are sent.
automations
on_enter boolean Send entries. Default
true.on_exit boolean Send exits. Default
true.on_backfill boolean Also send changes from the initial backfill and periodic time-based re-checks. Default
false, so creating a segment doesn't flood you.Payload#
{
"idempotency_key": "4b1f0c2d9e8a7b6c5d4e3f2a1b0c9d8e",
"tenant_id": "breeze",
"workspace_id": "my-store",
"segment_id": "vip-customers",
"profile_id": "60de1d6e-748f-87dc-ab33-bfbbaba9b299",
"transition": "entered",
"origin": "live-eval",
"evaluated_version": 3,
"occurred_at": "2026-10-08T10:15:04Z"
}Fields
transition string entered or exited.origin string Why it changed:
live-eval: an event changed a metric.backfill: segment creation or a time-based re-check.merge-remap: two profiles merged.
profile_id string Who. Fetch details with
GET .../profiles/{profile_id} (Profiles API).idempotency_key string Stable per change. Use it to drop duplicate deliveries.
Delivery#
| Rule | What it means for you |
|---|---|
| At-least-once delivery | Any 2xx counts as delivered; anything else is retried until it succeeds. Deduplicate on idempotency_key. |
| No personal data | Webhooks carry ids only. Call the profile API for emails, phones and metrics. |
| URL set by the BreezeIQ team | The webhook URL is set per environment. Send the BreezeIQ team your endpoint. |
| Routing | Route on workspace_id and segment_id. |
Prefer polling?
Use segment members or the single-customer membership check instead of webhooks.