Agendize Watchers API

Watchers API Reference

The Watchers API empowers you to watch your client interactions.


Resource representation

{ "id": {string}, "address": {string}, "name": {string}, "basicAuth": { "username": {string}, "password": {string} }, "httpRequestHeader": { (name): {string} }, "objectOwner": { "type": {string}, "id": {boolean} }, "schema": {object}, "addPreviousData": {boolean}, "levelDetails": {string}, "method": {string}, "status": {string} }
Parameter name Value Description
address string The address where notifications are delivered for this watch.
Optional Properties
name string Name of the watch.
basicAuth string Credentials parameters for HTTP Basic authentication on the destination watch address. Only if you use this authentication method.
basicAuth.username string Username.
basicAuth.password string Password.
httpRequestHeader string Custom header parameters to send with the http request on the destination watch address.
httpRequestHeader.name string header parameter name.
schema object Custom json schema to apply for resource properties.
addPreviousData boolean Add data of the previous version of the resource.
levelDetails string level json details for the resource. Values: "full" or "extraFull". Default value is "full".
method string HTTP Method to use for sending content. DELETE Method doesn't accept body content.
status string Status of the watcher. Values: "enabled", "disabled"

Delete

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

Request

HTTP Request

DELETE https://api.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 https://api.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 https://api.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] }