Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Last Updated:

Lastupdatedate

Livesearch
placeholderSearch the Vibes Developer Wiki
typepage



Acquisition Participant Added
Anchor
ackparticipantadded
ackparticipantadded

This callback event is triggered when a new Participant has been added to the Acquisition Campaign.

StatusDescription
PENDINGAcquisition 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",
   "event_type":"ack_participant_added",
   "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
ackparticipantchanged
ackparticipantchanged

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).

StatusDescription
CONFIRMEDParticipant confirmed opt-in by replying Y, or with zip code, and is now subscribed
REJECTEDParticipant declined confirmation by replying N or No and the acquisition flow is terminated

Callback Body

Code Block
{
   "event_id":"AB234SDFD234",
   "event_type":"ack_participant_changed",
   "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