How It Works

When using this POST method, you are essentially creating a fake trigger that will activate your registered callback. The callback your endpoint receives should be used only to indicate that your system is receiving callbacks as intended.

Depending on the callback_type, you will need to pass along certain required elements to properly test the callback. For example, to test an acquisition campaign callback, you will need to give the system of the acquisition campaign that you registered to receive callbacks for. The requirements vary; see the below chart for more information.

You can also pass along optional data that will override the default values of the callback. Note that this data is dummy information for the purposes of testing only; it will not affect your existing account data.

Request

See a list of the callbacks you can test, as well required and optional elements see the table below.

Callback	Required Elements	Optional Override Data
Acquisition participant added	`callback_type` `partipant.acquisition_campaign.api_key`	`participant.person.id` `participant.mobile_phone.mdn` `partipant.acquisition_campaign.description` `partipant.acquisition_campaign.keyword` `participant.subscription_list.id`
Acquisition participant removed	`callback_type` `partipant.acquisition_campaign.api_key`	`participant.person.id` `participant.mobile_phone.mdn` `partipant.acquisition_campaign.description` `partipant.acquisition_campaign.keyword` `participant.subscription_list.id`
Company participant added	`callback_type`	`partipant.acquisition_campaign.api_key` `participant.person.id` `participant.mobile_phone.mdn` `partipant.acquisition_campaign.description` `partipant.acquisition_campaign.keyword` `participant.subscription_list.id`
Company participant changed	`callback_type`	`partipant.acquisition_campaign.api_key` `participant.person.id` `participant.mobile_phone.mdn` `partipant.acquisition_campaign.description` `partipant.acquisition_campaign.keyword` `participant.subscription_list.id`
Event-triggered callback	`callback_type` `event_processed.event_type`	`event_processed.event_id` `event_processed.event_data` `event_processed.debug_data` `event_processed.action`
Person added	`callback_type`	`person.person_id` `person.external_person_id` `person.mobile_phone.mdn` `person.mobile_phone.carrier_code` `person.custom_fields`
Person updated	`callback_type`	`person.person_id` `person.external_person_id` `person.mobile_phone.mdn` `person.mobile_phone.carrier_code` `person.custom_fields`
Device added	`callback_type` `push_device.app_id`	`person.person_id` `person.external_person_id` `push_device.vibes_device_id` `push_device.push_token` `push_device.device_os`
Device removed	`callback_type` `push_device.app_id`	`person.person_id` `person.external_person_id` `push_device.vibes_device_id` `push_device.push_token` `push_device.device_os`
Device updated	`callback_type` `push_device.app_id`	`person.person_id` `person.external_person_id` `push_device.vibes_device_id` `push_device.push_token` `push_device.device_os`
Subscription added	`callback_type` `subscription.subscription_list.id`	`subscription.acquisition_campaign.api_key` `subscription.person.id`
Subscription removed	`callback_type`	`subscription.acquisition_campaign.api_key` `subscription.opt_out_date` `subscription.opt_out_reason` `subscription.person.id` `subscription.subscription_list.id`
Subscription list added	`callback_type`	`subscription_list.name` `subscription_list.id`
Subscription list updated	`callback_type`	`subscription_list.name` `subscription_list.id`

Response

An HTTP 201 - CREATED will be returned if the callback was queued for send.
An HTTP 404 - NOT FOUND error will be returned if an active callback does not exist.

Returned Callback

If all is working correctly, your callback endpoint will receive a callback. It should contain the event_id returned in the response to the test request and any dummy information you provided.