Page History

Callback Entity

The following is the JSON representation of a

callback entity within the APIs.

18T19:30Z"
}

Elements

Examples

Person Callback Types

The person_added callback event is triggered when a new Person record is added into the Mobile Database.

To register an endpoint to receive the person_added callback, follow this example

{
  "callback_type":"person_added",
  "destination":{
     "url":"https://YOUR.DESTINATION.URL",
     "method":"POST",
     "content_type":"application/json"
  }
}

The person_updated

callback event is

triggered when an existing Person record has been modified in the Mobile Database.

To register an endpoint to receive the person_updated callback, follow this example

{
  "callback_type":"person_updated",
  "destination":{
     "url":"https://YOUR.DESTINATION.URL",
     "method":"POST",
     "content_type":"application/json"
  }
}

More information on Person Callbacks is available here.

Subscription

Callback Types

The subscription_added

callback event is

triggered when a Person has been added to a Subscription List.

The subscription_removed

callback event is

triggered when a Person has been

removed from a Subscription List.

To register an endpoint to receive the subscription_added callback, follow this example:

{
   "callback_type":

DESTINATION.URL",
     "method":"POST",
     "content_type":"application/json"
  }
}

To register an endpoint to receive the subscription_removed callback, follow this example:

DESTINATION.URL",
     "method":"POST",
     "content_type":"application/json"
  }
}

More information on Subscription Callbacks is available here.

Acquisition Campaign Callback Types

The ack_participant_added

 callback event is

triggered when a new

Participant has been added to the

Acquisition Campaign.

To register an endpoint to receive the ack_participant

_added callback, follow this example:

{
  "callback_type": "ack_participant_added",
  "ack_participant_changed": {
      "campaign_id": "YOUR_ACQUISITION_CAMPAIGN_KEY"
    },
  "destination":{
     "url":"https://YOUR.DESTINATION.URL",
     "method":"POST",
     "content_type":"application/json"
  }
}

The ack_participant_changed callback event is triggered when a Participant has confirmed or declined the opt-in.

To register an endpoint to receive the ack_participant_changed callback, follow this example:

{
  "callback_type": "ack_participant_changed",
  "ack_participant_changed": {
      "campaign_id": "YOUR_ACQUISITION_CAMPAIGN_KEY"
    },
  "destination":{
     "url":"https://YOUR.DESTINATION.URL",
     "method":"POST",
     "content_type":"application/json"
  }
}

More information on Acquisition Callbacks is available here.

Subscription List Callback Types

The subscription_list_added callback event is triggered when a new Subscription List has been created in the Mobile Database.

To register an endpoint to receive the subscription_list_added callback, follow this example:

{
  "callback_type":"subscription_list_added",
  "destination":{
     "url":"https://YOUR.DESTINATION.URL",
     "method":"POST",
     "content_type":"application/json"
  }
}

The subscription_list_updated callback event is triggered whenever a Subscription List has been modified in the Mobile Database.

To register an endpoint to receive the subscription_list_updated callback, follow this example:

{
  "callback_type":"subscription_list_updated",
  "destination":{
     "url":"https://YOUR.DESTINATION.URL",
     "method":"POST",
     "content_type":"application/json"
  }
}

More information on Subscription List Callbacks is available here.

Unmatched Message Callback Types

The unmatched_message_received callback event is triggered when a message originating from a consumer does not match any campaign or system keyword.

To register an endpoint to receive the unmatched_message_received callback, follow this example:

{
   "callback_type": "

COUNTRY_CODE"
   },
   "destination":{
     "url":"https://YOUR.DESTINATION.URL",
     "method":"POST",
     "content_type":"application/json"
  }
}

More information on Unmatched Message Callbacks is available here.

Wallet Callback Types

The wallet_item_install callback event is triggered when a new wallet item is installed by an end user.

To register an endpoint to receive the wallet_item_install callback, follow this example:

{
  "callback_type": "wallet_item_install",
  "wallet_item_install": {
    "campaign_token": "YOUR_WALLET_CAMPAIGN_TOKEN"
  },
  "destination":{
     "url":"https://YOUR.DESTINATION.URL",
     "method":"POST",
     "content_type":"application/json"
  }
}

The wallet_item_remove callback event is triggered when a wallet item is removed by an end user.

To register an endpoint to receive the wallet_item_remove callback, follow this example:

{
  "callback_type": "

DESTINATION.URL",
     "method":"POST",
     "content_type":"application/json"
  }
}

More information on Wallet Callbacks is available here.

Push Device Callback Types

The device_added callback event is triggered when a new app has been installed on a device or when a device is moved from another person to this person.

To register an endpoint to receive the device_added callback, follow this example:

{
  "callback_type": "device_added",
  "device_added": {
    "app_id": "YOUR_APPLICATION_ID"
  },
  "destination":{
     "url":"https://YOUR.DESTINATION.URL",
     "method":"POST",
     "content_type":"application/json"
  }
}

The device_removed callback event is triggered when an app has been uninstalled from a device, otherwise no longer available, or when a device is moved from this person to another person.

To register an endpoint to receive the device_removed callback, follow this example:

{
  "callback_type": "device_removed",
  "device_added": {
    "app_id": "YOUR_APPLICATION_ID"
  },
  "destination":{
     "url":"https://YOUR.DESTINATION.URL",
     "method":"POST",
     "content_type":"application/json"
  }
}

The device_updated callback event is triggered when an Apple or Google push_token is added or removed.  It will not be triggered for other types of updates.  

To register an endpoint to receive the device_updated callback, follow this example:

{
  "callback_type": "device_updated",
  "device_added": {
    "app_id": "YOUR_APPLICATION_ID"
  },
  "destination":{
     "url":"https://YOUR.DESTINATION.URL",
     "method":"POST",
     "content_type":"application/json"
  }
}

More information on Push Device Callbacks is available here.

Event-Triggered Callback Types

The Event-Triggered Callback, also known as the event_processed callback, is triggered when the processing status of an Event has changed. You can configure the callback to be triggered only for a specific event_type or choose to receive callbacks for all processed events, regardless of event_type.

To register an endpoint to receive the event_processed callback, follow this example:

{
  "callback_type":"event_processed",
  "event_processed": {
    "event_type": "order_shipped"
  },
  "destination":{
    "url":"http://some.url",
    "method":"POST",
    "content_type":"application/json"
  },
  "start_date":"2017-01-01T00:00Z",
  "end_date":"2017-02-01T00:00Z",
}

To receive callbacks for all processed events, simply remove the event_type. See example below:

{
  "callback_type":"event_processed",
  "destination":{
    "url":"http://some.url",
    "method":"POST",
    "content_type":"application/json"
  },
  "start_date":"2017-01-01T00:00Z",
  "end_date":"2017-02-01T00:00Z",
}

Find more information on Event-Triggered Callbacks here.