Last Updated:



The following methods describe how and why Subscription Added and Subscription Removed callback events are used, including examples.

Subscription Added Callback

This callback event is triggered when a new Subscription has been added to a Person. The Subscription object contains the reference to the Subscription that was added.

NoteMDN formats in callback events are determined by the API version used when creating and altering the callbacks. If Version 2 is used, MDNs will be represented in the E.164 international format. Otherwise, MDNs will be represented without a country code.

Callback Body

{
   "event_id":"AB234SDFD234",
   "event_type":"subscription_added",
   "event_date":"2017-03-15T15:42:23Z",
   "subscription":{
      "person":{
         "id":"ABC123",
         "external_id":"ex1234",
         "external_person_id":"ex1234",
         "person_key":"c5235a1-e243-42z7-979c-7f6234kl21b60",
         "url":"/companies/:company_key/mobiledb/persons/ABC123",
         "mobile_phone":{
           "mdn":"+1999999999"
         }
      },
      "subscription_list":{
         "id":"1234",
         "url":"/companies/:company_key/mobiledb/subscription_lists/1234"
      },
      "opt_in_date":"2017-01-15T15:34:52Z"
   }
}

Subscription Removed Callback

This callback event is triggered whenever a Subscription has been removed from a Person. The Subscription object contains reference to the Subscription that was removed.

NoteMDN formats in callback events are determined by the API version used when creating and altering the callbacks. If Version 2 is used, MDNs will be represented in the E.164 international format. Otherwise, MDNs will be represented without a country code.

Callback Body

{
   "event_id":"AB234SDFD234",
   "event_type":"subscription_removed",
   "event_date":"2017-03-15T15:42:23Z",
   "subscription":{
      "person":{
         "id":"ABC123",
         "external_id":"ex1234",
         "external_person_id":"ex1234",
         "person_key":"c5235a1-e243-42z7-979c-7f6234kl21b60",
         "url":"/companies/:company_key/mobiledb/persons/ABC123",
         "mobile_phone":{
           "mdn":"+1999999999"
         }
      },
      "subscription_list":{
         "id":"1234",
         "url":"/companies/:company_key/mobiledb/subscription_lists/1234"
      },
      "opt_in_date":"2017-01-15T15:34:52Z",
      "opt_out_date":"2017-02-18T15:34:52+0000",
      "opt_out_reason":"user_opt_out"
   }
}


opt_out_reason values

Opt out reasonDescription
disconnectThe device associated with the subscription was disconnected
list_archivedThe list associated with the subscription was archived
bulk_opt_outThe subscriber was included in a bulk opt out file
failed_at_carrierAn error from the carrier was received when attempting to deliver an SMS to the device
obsolete_carrierDevice was on a carrier that is no longer supported by vibes
platform_opt_outThe subscription was removed manually using the Vibes Platform
keyword_opt_outThe subscription was removed after receiving a STOP keyword from the device
api_opt_outThe subscription was removed via the Subscription API
user_opt_outDefault when no other reason is specified.
button_opt_outOpted out via the "subscriptions" tab in the Campaign Manager UI

Note: Vibes may add additional opt_out_reason options in the future.

Additional Resources