Get a Callback

The following will retrieve a callback by its callback_id.

GET /companies/:company_

Request JSON

There is no Request JSON with a GET.

Return JSON

A callback entity.

List Callback

The following will list active and future callbacks.

Code Block

Request JSON

There is no Request JSON with a GET.

Return JSON

An

array of

callback elements will be returned as follows.

[

   }
]

Create a Callback

The following will create a new callback record.

Code Block

The

callback_id, created_at, updated_at, and

URL fields are not allowed

. Any values will be ignored.

The destination_method, content_type, start_date, and end_date fields are optional.

Two callback registrations may not share an event type if they have overlapping active date ranges.

Return JSON

A callback entity.

For information on how to create a specific callback, see Callback Configuration.

Delete a Callback

Code Block

This will set the end date of the callback

to now and change it to inactive. If the start date of the callback

was in the future, it will change that to now as well.

Return JSON

A

callback entity reflecting the new date ranges and active state.

Create a Test Callback Event

POST /companies/:company_key/config/callback_events/test

{
  "event_type": "person_added"
}

{
   "event_type":"subscription_added",
   "subscription":{
      "subscription_list":{
         "id":"my_list"
      }
   }
}

{
   "event_type":"ack_participant_added",
   "participant":{
      "acquisition_campaign":{
         "id":"my_campaign"
      }
   }
}

{
   "message":"Created event for event_type 'person_added'",
   "event_id":"AB234SDFD234"
}

{
   "errors":[
      {
         "message":"Could not find a callback registration for event type 'person_added'"
      }
   ]
}

Returned Callback

Your callback endpoint will receive an event like the one shown below. It will contain the event_id returned in the response to the test request, and the details of the callback endpoint we are calling.

{
   "event_id":"AB234SDFD234",
   "callback_id":"C1234",
   "event_type":"person_added",
   "event_date":"2017-02-15T15:42:23Z",
   "delivery_attempt":"1",
   "person":...
}