Versions Compared

Key

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

Overview

A Callback registration 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 registration is unique for a given event type and active date range.

...

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

Code Block
{
 "callback_id": "AB3423",
 "event_type": "person_added",
 "destination_url": "http://destination.url",
 "destination_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

Default

callback_id

String

Vibes unique identifier for each callback registration record.

required

 

event_type

String

Event type to trigger this callback.

required

 

campaign_id

String

Vibes unique identifier for an acquisition campaign.

required

 

list_id

String

Vibes unique identifier for a subscription list.

required for subscription events

 

destination_url

String

External url to submit the callback data.

required

 

destination_method

String

Method to submit the data to the destination url.

optional

POST

content_type

String

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

optional

application/json

start_date

String

Date this callback registration starts

optional

now

end_date

String

Date this callback registration ends

optional

no end date

url

String

Unique resource url for the callback registration

n/a

 

created_at

String

Date this callback registration was created

n/a

 

updated_at

String

Date this callback registration was last updated

n/a

 

Valid Event Types

...