Callback APIs

Overview

A Callback registration 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 registration is unique for a given event type and active date range.

Callback Entity

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

{
 "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 registration 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 registration starts	optional	now
end_date	String	Date this callback registration ends	optional	no end date
url	String	Unique resource url for the callback registration	n/a
created_at	String	Date this callback registration was created	n/a
updated_at	String	Date this callback registration was last updated	n/a

Valid 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_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.
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.
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 changed because the Person has confirmed the opt-in or declined the opt-in.

Valid Destination Methods

POST, PUT

Valid Content Types

application/json
FUTURE: application/xml, text/xml