Segment build succeeded

POST

POSTed to your webhook URL when an async segment (matched file upload, similarity, or propensity) transitions to active. Configure your URL via PUT /v1/settings/webhook or supply webhook_url per-request. segment_id is the primary identifier; 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).

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

Posted to your webhook_url when a segment transitions to active. Fired by matched, similarity, and propensity segments upon completion.

object

event

required

string

Allowed values: segment.ready

segment_id

required

string

audience_id

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

string | null

org_id

required

string

status

required

string

Allowed values: active

subtype

required

string

Allowed values: matched similarity propensity

record_count

integer | null

match_count

Present for matched subtype only.

integer | null

Example

{
  "event": "segment.ready",
  "segment_id": "seg_abc123",
  "audience_id": "aud_abc123",
  "org_id": "org_xyz",
  "subtype": "matched",
  "status": "active",
  "record_count": 1200000
}

Responses

200

Your endpoint acknowledged the event.