The Watchers API empowers you to watch your client interactions.
| 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" |
oauth2Auth |
string |
Credentials parameters for HTTP OAuth2 authentication on the destination watch address. Only if you use this authentication method. |
oauth2Auth.clientId |
string |
OAuth2 client id. |
oauth2Auth.refreshToken |
string |
OAuth2 refresh token. |
oauth2Auth.authUrl |
string |
OAuth2 interactive end point to initiate the generation of the refresh token. |
oauth2Auth.accessTokenUrl |
string |
OAuth2 end point to generation an access token from the refresh token. |
oauth2Auth.scope |
string |
OAuth2 api scope. |
signature |
object |
Produces a crypto signature of the watched content. |
signature.enabled |
boolean |
Sets if the signature is enabled or not. |
signature.cryptoKeyIds |
list |
List of crypto key identifier. |
Authentication is required to execute this request. Please refer to Authentication for more.
{watcherId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
watcherId |
string |
Watcher identifier. |
Do not supply a request body with this method.
If successful, this method returns an empty response body.
Returns an entry of the watcher list.
Authentication is required to execute this request. Please refer to Authentication for more.
{watcherId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
watcherId |
string |
Watcher identifier. |
Do not supply a request body with this method.
If successful, this method returns a Watcher resource in the response body.
Returns entries on the watcher list.
Authentication is required to execute this request. Please refer to Authentication for more.
| Parameter name | Value | Description |
|---|---|---|
| Optional query parameters | ||
objectType |
datetime |
Type of the watchers's objects. Values: 'schedulingCompany', 'callTracking', 'clickToCall'. |
Do not supply a request body with this method.
If successful, this method returns a response body with the following structure: