Register for a new callback type

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Before you register...

Set up your endpoint before sending any callback configurations. Do not use a "fake" URL to test the configuration, as this will result in errors.

Request

The registration request body varies depending on which callback you are registering for. Example bodies can be found in the reference for whichever callback you are registering for.

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

Path Params
string
required
Important: Please note that the "Try It" feature to the right will send an actual API call to our system, which may result in your company being registered for a new callback.
Body Params
string
enum
required

The type of callback to register.

Allowed:
destination
object
required
ack_participant_changed
object

Required for Acquisition Changed callback.

ack_participant_added
object

Required for Acquisition Added callback.

string

Date you’d like to start receiving this callback in ISO-8601 format. Leave blank to start immediately.

string

Date you’d like to stop receiving this callback in ISO-8601 format. Leave blank for no end date.

Headers
string
Defaults to 1
Responses

201

Callback has been successfully registered.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json