Page History
...
Code Block |
---|
{
"callback_id": "AB3423",
"event_type": "person_added",
"destination_url": "http://destination.url",
"destination_method": "POST",
"content_type": "application/json",
"start_date": "2010-01-01T00:00Z",
"end_date": "2020-01-01T00:00Z",
"url": "/companies/:id/mobiledb/config/callbacks/:callback_id",
"created_at": "2012-04-05T14:30Z",
"updated_at": "2012-05-08T19:30Z",
}
|
Elements
Data Element | Type | Description | Required | Default |
---|---|---|---|---|
callback_id | String | Vibes unique identifier for each callback record. | required |
|
event_type | String | Event type to trigger this callback. | required |
|
campaign_id | String | Vibes unique identifier for an acquisition campaign. | required |
|
list_id | String | Vibes unique identifier for a subscription list. | required for subscription events |
|
destination_url | String | External url to submit the callback data. | required |
|
destination_method | String | Method to submit the data to the destination url. | optional | POST |
content_type | String | Content type to set when submitting the data to the destination url. | optional | application/json |
start_date | String | Date this callback starts | optional | now |
end_date | String | Date this callback ends | optional | no end date |
url | String | Unique resource url for the callback | n/a |
|
created_at | String | Date this callback was created | n/a |
|
updated_at | String | Date this callback was last updated | n/a |
|
...
Person Event Types
Event Type | Description |
---|---|
person_added | This callback event is fired whenever a new Person record is added into the Mobile Database. |
person_updated | This callback event is fired whenever an existing Person record has been modified in the Mobile Database. |
Subscription Event Types
Event Type | Description |
---|---|
subscription_added | This callback event is fired when a new subscription has been added to a Person for a List. |
subscription_removed | This callback event is fired whenever a subscription has been removed from a Person for a List. |
Data Element | Type | Description | Required |
---|---|---|---|
list_id | String | Vibes unique identifier for a subscription list. | required |
Code Block |
---|
{ ... "event_type": "subscription_added", "subscription_added": { "subscription_list_id": "l1234" }, ... } |
Code Block |
---|
{ ... "event_type": "subscription_removed", "subscription_removed": { "subscription_list_id": "l1234" }, ... } |
Acquisition Campaign Event Types
Event Type | Description |
---|---|
ack_participant_added | This callback event is fired when a new subscription list participant has been created in the Mobile Databaseadded to the Acquisisition Campaign. |
subscription ack_listparticipant_updated | This callback event is fired whenever a subscription list has been modified in the Mobile Database. ack_participant_participant's status has confirmed or declined the opt-in. |
Data Element | Type | Description | Required |
---|---|---|---|
acquisition_campaign_id | String | Vibes unique identifier for an acquisition campaign. | required |
Code Block |
---|
{
...
"event_type": "ack_participant_added",
"ack_participant_added": {
"acquisition_campaign_id": "c1234"
},
...
}
|
Code Block |
---|
{
...
"event_type": "ack_participant_removed",
"ack_participant_removed": {
"acquisition_campaign_id": "c1234"
},
...
}
|
Subscription List Event Types
subscription_list_added | This callback event is fired when a new participant subscription list has been added to the Acquisisition Campaigncreated in the Mobile Database. |
ack subscription_participantlist_updated | This callback event is fired whenever a participant's status has changed because the Person has confirmed the opt-in or declined the opt-insubscription list has been modified in the Mobile Database. |
Valid Destination Methods
...