Create a test callback event

After you register for a callback, you may want to test to make sure your endpoint is correctly receiving the callbacks as intended. Rather than waiting for the trigger to occur, you can create a test trigger using the POST call to the above. If working correctly, your system will receive a test callback from Vibes.

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.

CallbackRequired ElementsOptional Override Data
Acquisition participant addedcallback_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 removedcallback_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 addedcallback_typepartipant.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 changedcallback_typepartipant.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 callbackcallback_type
event_processed.event_type
event_processed.event_id
event_processed.event_data
event_processed.debug_data
event_processed.action
Person addedcallback_typeperson.person_id
person.external_person_id
person.mobile_phone.mdn
person.mobile_phone.carrier_code
person.custom_fields
Person updatedcallback_typeperson.person_id
person.external_person_id
person.mobile_phone.mdn
person.mobile_phone.carrier_code
person.custom_fields
Device addedcallback_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 removedcallback_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 updatedcallback_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 addedcallback_type
subscription.subscription_list.id
subscription.acquisition_campaign.api_key
subscription.person.id
Subscription removedcallback_typesubscription.acquisition_campaign.api_key
subscription.opt_out_date
subscription.opt_out_reason
subscription.person.id
subscription.subscription_list.id
Subscription list addedcallback_typesubscription_list.name
subscription_list.id
Subscription list updatedcallback_typesubscription_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.

Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!