Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

A Callback entity is a registration to receive callback events to an external urlURL. It is identified by a CallbackID, which uniquely identifies the record. Additionally, each callback is unique for a given event type and active date range.

Contents 

Page Treeroot@selfstartDepth1

Callback Entity

This The following is the JSON representation of a Callback entity within the APIs.

...

Data Element

Type

Description

Required

Default

callback_id

String

Vibes unique identifier for each callback record.

requiredRequired

 

event_type

String

Event type to trigger this callback.

requiredRequired

 

destination.url

String

External url URL to submit the callback data.

requiredRequired

 

destination.method

String

Method to submit the data to the destination urlURL.

optionalOptional

POST

destination.content_type

String

Content type to set when submitting the data to the destination urlURL.

optionalOptional

application/json

start_date

String

Date this callback starts.

optionalOptional

now

end_date

String

Date this callback ends.

optionalOptional

no end date

url

String

Unique resource url URL for the callback.

nN/aA

 

created_at

String

Date this callback was created.

nN/aA

 

updated_at

String

Date this callback was last updated.

nN/aA

 

Person Event Types

Event Type

Description

person_added

This callback event is fired whenever triggered when a new Person record is added into the Mobile Database.

person_updated

This callback event is fired whenever triggered when an existing Person record has been modified in the Mobile Database.

...

Event Type

Description

subscription_added

This callback event is fired triggered when a Person has been added to a Subscription List.

subscription_removed

This callback event is fired whenever triggered when a Person has been removed from a Subscription List.

Data Element

Type

Description

Required

list_id

String

Vibes unique identifier for a subscription Subscription list.

requiredRequired

Code Block
{
  ...
  "event_type": "subscription_added",
  "subscription_added": {
    "list_id": "l1234"
  },
  ...
}

...

Event Type

Description

ack_participant_added

This callback event is fired triggered when a new participant has been added to the Acquisisition Acquisition Campaign.

ack_participant_changed

This callback event is fired whenever triggered when a participant 's status has confirmed or declined the opt-in.

Data Element

Type

Description

Required

campaign_id

String

Vibes unique identifier for an acquisition campaignAcquisition Campaign.

requiredRequired

Code Block
{
  ...
  "event_type": "ack_participant_added",
  "ack_participant_added": {
    "campaign_id": "c1234"
  },
  ...
}

...

subscription_list_added

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

subscription_list_updated

This callback event is fired triggered whenever a subscription list Subscription List has been modified in the Mobile Database.

...