Table of Contents

Get a Callback Registration

GET /companies/:company_id/campaigns/config/callbacks/:callback_id

This will retrieve a Callback registration by its callback_id

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

Return JSON

A Callback registration entity

List Callback Registrations

GET /companies/:company_id/campaigns/config/callbacks

This will list active and future the callback registrations.

Return JSON

An Array of Callback registration elements will be returned.

[{
 "callback_id": "AB3423",
 "event_type": "ack_participant_added",
 "campaign_id": "c1234",
 "destination_url": "http://some.url",
 "destination_method": "POST",
 "content_type": "application/json",
 "start_date": "2010-01-01T00:00Z",
 "end_date": "2020-01-01T00:00Z",
 "url": "/companies/:id/campaigns/config/callbacks/:callback_id",
 "created_at": "2012-04-05T14:30Z",
 "updated_at": "2012-05-08T19:30Z",
}]

Create a Callback Registration

POST /companies/:company_id/campaigns/config/callbacks/

This will create a new Callback registration record.  

The fields callback_id, created_at, updated_at, and 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 response will be returned if the object has been successfully created.

Return JSON

A Callback registration entity

Delete a Callback Registration

DELETE /companies/:company_id/campaigns/config/callbacks/:callback_id

An HTTP 200 - OK will be returned if the operation completes successfully.

An HTTP 404 - Not Found will be returned if the entity does not exist.

This will set the end date of the callback registration to now and change it to inactive. If the start date of the callback registration was in the future, it will change that to now as well.

Return JSON

A Callback registration entity reflecting the new date ranges and active state.