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 url. 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 Tree
root@self
startDepth1

Callback Entity

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

Code Block

{
   "callback_id":"AB3423",
   "event_type":"person_added",
   "destination":{
      "url":"http://destination.url",
      "method":"POST",
      "content_type":"application/json"
   },
   "start_date":"2010-01-01T00:00Z",
   "end_date":"2020-01-01T00:00Z",
   "url":"/companies/:id/mobiledb/config/callbacks/:callback_id",
   "created_at":"2012-04-05T14:30Z",
   "updated_at":"2012-05-08T19:30Z"
}

...

Data Element

Type

Description

Required

list_id

String

Vibes unique identifier for a subscription list.

required

Code Block

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

{
  ...
  "event_type": "subscription_removed",
  "subscription_removed": {
    "list_id": "l1234"
  },
  ...
}

...

Data Element

Type

Description

Required

campaign_id

String

Vibes unique identifier for an acquisition campaign.

required

Code Block

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

{
  ...
  "event_type": "ack_participant_changed",
  "ack_participant_changed": {
    "campaign_id": "c1234"
  },
  ...
}

...