Agendize Wacthers API

Watchers API Reference

The Watchers API empowers you to watch your client interactions.


Resource representation

{ "id": {string}, "address": {string}, "objectOwner": { "type": {string}, "id": {boolean} } }
Parameter name Value Description
id string Identifier of the watcher.
address string The address where notifications are delivered for this watcher.
objectOwner object Object owner of the watch.
objectOwner.type string Type of the object. values: 'schedulingCompany', 'callTracking', 'clickToCall'.
objectOwner.id string Identifier of the object.

Delete

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

DELETE http://az2.agendize.com/api/2.0/watchers/{watcherId}

Parameters

Parameter name Value Description
Path parameters
watcherId string Watcher identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.


Get

Returns an entry of the watcher list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET http://az2.agendize.com/api/2.0/watchers/{watcherId}

Parameters

Parameter name Value Description
Path parameters
watcherId string Watcher identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Watcher resource in the response body.


List

Returns entries on the watcher list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET http://az2.agendize.com/api/2.0/watchers

Parameters

Parameter name Value Description
Optional query parameters
objectType datetime Type of the watchers's objects. Values: 'schedulingCompany', 'callTracking', 'clickToCall'.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{ items: [Watcher Resource] }