Page History
Last Updated:
| Lastupdatedate |
|---|
| Livesearch | ||||
|---|---|---|---|---|
|
Acquisition Participant Added
| Anchor | ||||
|---|---|---|---|---|
|
This callback event is triggered when a new Participant has been added to the Acquisition Campaign.
| Status | Description |
|---|---|
| PENDING | Acquisition flow has begun and is waiting for confirmation from participant |
Callback Body
The event includes the information on the Participant and the Acquisition Campaign.
| Code Block |
|---|
{
"event_id":"AB234SDFD234",
"callback_type":"ack_participant_added",
"event_type":"ack_participant_added", //deprecated
"event_date":"2017-03-15T15:42:23Z",
"delivery_attempt":"1",
"participant":{
"person":{
"id":"AB3423",
"external_id":"ex123",
"mobile_phone":{
"mdn":"+12995551234"
},
"url":"/companies/:company_key/mobiledb/persons/AB3423"
},
"acquisition_campaign":{
"id":"C1323542",
"description":"Great Acquisition Campaign",
"url":"/companies/:company_key/campaigns/acquisition/ACQ1234",
"keyword":"SUBSCRIBED"
},
"participation_date":"2017-01-14T14:30Z",
"expire_date":"2017-01-15T14:30Z",
"status":"PENDING"
}
}
|
Acquisition Participant Changed
| Anchor | ||||
|---|---|---|---|---|
|
This callback event is triggered whenever a Participant's status has changed due to either confirming or declining an opt-in. Participation timeouts and automatically-confirmed opt-ins will not trigger this event (only the initial Add event).
| Status | Description |
|---|---|
| CONFIRMED | Participant confirmed opt-in by replying Y, or with zip code, and is now subscribed |
| REJECTED | Participant declined confirmation by replying N, No, or any STOP phrase or keyword and the acquisition flow is terminated |
Callback Body
| Code Block |
|---|
{
"event_id":"AB234SDFD234",
"callback_type":"ack_participant_added",
"event_type":"ack_participant_changed", //deprecated
"event_date":"2017-03-15T15:42:23Z",
"delivery_attempt":"1",
"participant":{
"person":{
"id":"AB3423",
"external_id":"ex123",
"mobile_phone":{
"mdn":"+12995551234"
},
"url":"/companies/:company_key/mobiledb/persons/AB3423"
},
"acquisition_campaign":{
"id":"C1323542",
"description":"Great Acquisition Campaign",
"url":"/companies/:company_key/campaigns/acquisition/ACQ1234",
"keyword":"SUBSCRIBED"
},
"participation_date":"",
"expire_date":"",
"status":"CONFIRMED"
}
}
|
Additional Resources
- For information on how to register your endpoint to receive callbacks, see Callback Configuration
- Client Certificate Authentication for Callbacks from the Vibes Platform
Overview
Content Tools