API Reference

Subscription List Callbacks

These callbacks are triggered in response to changes in data associated with the Subscription List API. To receive callbacks, please make sure your endpoint is compatible with our endpoint specifications.

🚧

Before you register...

Set up your endpoint before sending any callback configurations. Do not use a "fake" URL to test the configuration, as this will result in errors.

Available Callbacks

Subscription List Added Callback

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

Callback configuration

When registering for this callback, your request body should look something like the below example.

{
  "callback_type":"subscription_list_added",
  "destination":{
     "url":"YOUR_DESTINATION_URL_W_HTTPS", /*Do not use a "fake" URL (such as google.com).*/
     "method":"POST",
     "content_type":"application/json"
  }
}

Callback body

The callback body refers to the new list that was added.

{
   "event_id":"AB234SDFD234",   
   "callback_type":"subscription_list_added",
   "event_type":"subscription_list_added", //deprecated
   "event_date":"2017-03-15T15:42:23Z",
   "subscription_list":{
      "id":"ABC12345",
      "name":"Wonderful Subscription List",
      "url":"/companies/:company_key/mobiledb/subscription_lists/ABC12345",
      "subscribers_url":"/companies/:company_key/mobiledb/subscription_lists/ABC12345/subscribers",
      "acquisition_campaigns_url":"/companies/:company_key/mobiledb/subscription_lists/ABC12345/acquisition_campaigns"
   }
}

Subscription List Updated Callback

This callback event is triggered whenever a subscription list has been updated in your mobile database.

Callback configuration

When registering for this callback, your request body should look something like the below example.

{
  "callback_type":"subscription_list_updated",
  "destination":{
     "url":"YOUR_DESTINATION_URL_W_HTTPS", /*Do not use a "fake" URL (such as google.com).*/
     "method":"POST",
     "content_type":"application/json"
  }
}

Callback body

When the callback is triggered, you will receive a callback that includes the updated subscription list elements.

{
   "event_id":"AB234SDFD234",
   "callback_type":"subscription_list_updated",
   "event_type":"subscription_list_updated", //deprecated
   "event_date":"2017-03-15T15:42:23Z",
   "subscription_list":{
      "id":"ABC12345",
      "name":"Wonderful Subscription List",
      "url":"/companies/:company_key/mobiledb/subscription_lists/ABC12345",
      "subscribers_url":"/companies/:company_key/mobiledb/subscription_lists/ABC12345/subscribers",
      "acquisition_campaigns_url":"/companies/:company_key/mobiledb/subscription_lists/ABC12345/acquisition_campaigns"
   }
}

Additional Resources