Agendize Developers API

Home > Agendize Scheduling

Scheduling buttons

Resource representation

{ "id": {string}, "name": {string}, "companyId": {string}, "language": {string} }
Parameter name Value Description
id string Identifier of the scheduling button. Read-only
name string Name of the scheduling button.. Max length 65535.
companyId string Scheduling company's identifiers.. Max length 63.
language string Language of the button. Supported languages: en, fr, es, de, pt, nl, it. Default value: language of the account.

Delete

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

Request

HTTP Request

DELETE https://api.agendize.com/api/2.1/scheduling/buttons/{buttonId}

Parameters

Parameter name Value Description
Path parameters
buttonId string Click-to-Call button identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.

Get

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

Request

HTTP Request

GET https://api.agendize.com/api/2.1/scheduling/buttons/{buttonId}

Parameters

Parameter name Value Description
Path parameters
buttonId string Call identifier.

Request body

Do not supply a request body with this method.

Response

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

List

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

Request

HTTP Request

GET https://api.agendize.com/api/2.1/scheduling/buttons

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: [Scheduling button Resource] }

Insert

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

Request

HTTP Request

POST https://api.agendize.com/api/2.1/scheduling/buttons

Request body

In the request body, supply a Scheduling button resource with the following properties:

Parameter name Value Description
Required Properties
name string Name of the scheduling button.
companyId string Scheduling company's identifiers.

Response

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

Update

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

Request

HTTP Request

PUT https://api.agendize.com/api/2.1/scheduling/buttons/{buttonId}

Parameters

Parameter name Value Description
Path parameters
buttonId string Scheduling button identifier.

Request body

In the request body, supply a Scheduling button resource with the following properties:

Parameter name Value Description
Optional Properties
name string Name of the scheduling button.
companyId string Scheduling company's identifiers.

Response

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

Watch

Watch for changes to Resource resources.

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

The watch send an Resource resource in the request body

Request

HTTP Request

POST https://api.agendize.com/api/2.1/scheduling/buttons/watch

Request body

{ "address": {string}, "name": {string}, "basicAuth": { "username": {string}, "password": {string} }, "httpRequestHeader": { {name}: {string} }, "schema": {object} "method": {string}, "status": {string}, "oauth2Auth": { "grantType": {string}, "clientId": {string}, "clientSecret": {string}, "refreshToken": {string}, "authUrl": {string}, "accessTokenUrl": {string}, "redirectUri": {string} }, "signature": { "enabled": {boolean}, "cryptoKeyIds": [ {string} ] } }
Required Properties
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.
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.grantType string OAuth2 grant type. Values: "refresh_token" (default), "client_credentials".
oauth2Auth.clientId string OAuth2 client id.
oauth2Auth.refreshToken string OAuth2 refresh token. Only for grantType "refresh_token"
oauth2Auth.authUrl string OAuth2 interactive end point to initiate the generation of the refresh token. Only for grantType "refresh_token"
oauth2Auth.accessTokenUrl string OAuth2 end point to generation an access token from the refresh token.
oauth2Auth.scope string OAuth2 api scope. Only for grantType "refresh_token"
signature object Produces a crypto signature of the watched content.
signature.enabled boolean Sets if the signature is enabled or not.
signature.cryptoKeyIds list Arrays of string of crypto keys identifier.

Response

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

Examples of schema:

With JSON, only for string value:

{ "schema": { "my_id_key": "{id}", "dataContent": { "givenName": "{firstName}" } } }

With string to support typed values:

{ "schema": "\"my_id_key\": ${$.id}, \"dataContent\": { \"fullName\": \"${$.firstName} ${$.lastName}\"}" }

Replacement string can by defined with jsonpath expressions.

Watch event supported

  • Button added in dashboard. In this case, the watch request add the following header propert in http request:
    X-Agendize-objectEvent: created
  • Button modified in dashboard. In this case, the watch request add the following header propert in http request:
    X-Agendize-objectEvent: updated
  • Button delete in dashboard. In this case, the watch request add the following header propert in http request:
    X-Agendize-objectEvent: deleted

Agendize | Support | Status

Last update: Oct 15, 2024 - Copyright © 2024 Agendize. All rights reserved.