Skip to content

Segment build succeeded

POST

POSTed to your webhook URL when an async segment (matched file upload, similarity, or propensity) completes successfully. Configure your URL via PUT /v1/settings/webhook, supply webhook_url per-request, or subscribe via POST /v1/webhook-subscriptions. subject.id is the segment id; data.audience_id is also present when an audience wrapper was auto-created alongside the segment (create_audience: true, which is the default for matched segments). See the Webhooks tag for the envelope shape and signing scheme.

Media typeapplication/json

Canonical envelope posted to your webhook when an async segment (matched file upload, similarity, or propensity) completes successfully.

object
id
required

Unique per event firing — stable across retries of the same delivery.

string
type
required
string
Allowed values: segment.ready
created_at
required
string format: date-time
api_version
required
string
org_id
required
string
subject
required

Identifies the segment this event is about.

object
kind
required
string
Allowed values: segment
id
required
string
name
required
string | null
data
required

status is always present; the remaining fields vary by segment subtype and creation path — treat any field not listed here as additive.

object
status
required
string
Allowed values: completed
audience_id

If create_audience was true when the segment was created, the ID of the auto-created audience wrapper. Null otherwise.

string | null
match_count

Present for matched subtype only.

integer | null
record_count
integer | null
key
additional properties
any
links
required

Reserved for future related-resource links. Currently always empty.

object
key
additional properties
any
Example
{
"id": "evt_1a2b3c4d5e6f7a8b9c0d1e2f",
"type": "segment.ready",
"created_at": "2026-08-26T18:04:12.000Z",
"api_version": "2026-08-06",
"org_id": "org_xyz",
"subject": {
"kind": "segment",
"id": "seg_abc123",
"name": "High-Value Purchasers"
},
"data": {
"status": "completed",
"audience_id": "aud_abc123",
"match_count": 1200000,
"record_count": 1500000
},
"links": {}
}

Your endpoint acknowledged the event.