Overview

A Callback entity is a registration to receive callback events to an external url. It is identified by a CallbackID, which uniquely identifies the record. Additionally, each callback is unique for a given event type and active date range.

Contents 

Callback Entity

This is the JSON representation of a Callback entity within the APIs.

{
 "callback_id": "AB3423",
 "event_type": "person_added",
 "destination": {
   "url": "http://destination.url",
   "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

 

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

destination.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 Person has been added to a Subscription List.

subscription_removed

This callback event is fired whenever a Person has been removed from a Subscription List.

Data Element

Type

Description

Required

list_id

String

Vibes unique identifier for a subscription list.

required

{
  ...
  "event_type": "subscription_added",
  "subscription_added": {
    "list_id": "l1234"
  },
  ...
}
{
  ...
  "event_type": "subscription_removed",
  "subscription_removed": {
    "list_id": "l1234"
  },
  ...
}

Acquisition Campaign Event Types

Event Type

Description

ack_participant_added

This callback event is fired when a new participant has been added to the Acquisisition Campaign.

ack_participant_updated

This callback event is fired whenever a 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

{
  ...
  "event_type": "ack_participant_added",
  "ack_participant_added": {
    "acquisition_campaign_id": "c1234"
  },
  ...
}
{
  ...
  "event_type": "ack_participant_updated",
  "ack_participant_removed": {
    "acquisition_campaign_id": "c1234"
  },
  ...
}

Subscription List Event Types

subscription_list_added

This callback event is fired when a new subscription list has been created in the Mobile Database.

subscription_list_updated

This callback event is fired whenever a subscription list has been modified in the Mobile Database.

Valid Destination Methods

POST
PUT

Valid Content Types

application/json
text/json
application/xml,
text/xml