Versions Compared

Key

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

Contents

Table of Contents
maxLevel3
minLevel2
exclude.*Contents.*

Get a Callback

The following will retrieve a Callback by its callback_id.

Code Block
GET /companies/:company_id/config/callbacks/:callback_id

This will retrieve a Callback by its callback_id

Note: A 404 - Not Found error will be returned if the Callback cannot be located.

Return JSON

A Callback entity

List Callback

The following will list active and future callbacks.

Code Block
GET /companies/:company_id/config/callbacks

This will list active and future the callbacks.

Return JSON

An Array of Callback elements will be returned as follows.

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

Create a Callback

The following will create a new Callback record.

Code Block
POST /companies/:company_id/config/callbacks/

This will create a new Callback record.  

The fields callback_id, created_at, updated_at, and url URL are not allowed in a create. Any values will be ignored.

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

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

...

An HTTP 201 - Created will be returned if the callback was queued for send.

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

An HTTP 404 - Not Found will be returned if an active callback does not exist.

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

...

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.

...