Skip to content
This repository was archived by the owner on Apr 14, 2024. It is now read-only.

Latest commit

 

History

History
388 lines (260 loc) · 11.5 KB

ObjectWebhookApi.md

File metadata and controls

388 lines (260 loc) · 11.5 KB

EZmaxApiDefinitionFull.ObjectWebhookApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method HTTP request Description
webhookCreateObjectV1 POST /1/object/webhook Create a new Webhook
webhookDeleteObjectV1 DELETE /1/object/webhook/{pkiWebhookID} Delete an existing Webhook
webhookEditObjectV1 PUT /1/object/webhook/{pkiWebhookID} Edit an existing Webhook
webhookGetHistoryV1 GET /1/object/webhook/{pkiWebhookID}/getHistory Retrieve the logs for recent Webhook calls
webhookGetListV1 GET /1/object/webhook/getList Retrieve Webhook list
webhookGetObjectV2 GET /2/object/webhook/{pkiWebhookID} Retrieve an existing Webhook
webhookTestV1 POST /1/object/webhook/{pkiWebhookID}/test Test the Webhook by calling the Url

webhookCreateObjectV1

WebhookCreateObjectV1Response webhookCreateObjectV1(WebhookCreateObjectV1Request)

Create a new Webhook

The endpoint allows to create one or many elements at once.

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectWebhookApi();
let WebhookCreateObjectV1Request = new EZmaxApiDefinitionFull.WebhookCreateObjectV1Request(); // WebhookCreateObjectV1Request | 
apiInstance.webhookCreateObjectV1(WebhookCreateObjectV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
WebhookCreateObjectV1Request WebhookCreateObjectV1Request

Return type

WebhookCreateObjectV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

webhookDeleteObjectV1

WebhookDeleteObjectV1Response webhookDeleteObjectV1(pkiWebhookID)

Delete an existing Webhook

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectWebhookApi();
let pkiWebhookID = 56; // Number | 
apiInstance.webhookDeleteObjectV1(pkiWebhookID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiWebhookID Number

Return type

WebhookDeleteObjectV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

webhookEditObjectV1

WebhookEditObjectV1Response webhookEditObjectV1(pkiWebhookID, WebhookEditObjectV1Request)

Edit an existing Webhook

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectWebhookApi();
let pkiWebhookID = 56; // Number | 
let WebhookEditObjectV1Request = new EZmaxApiDefinitionFull.WebhookEditObjectV1Request(); // WebhookEditObjectV1Request | 
apiInstance.webhookEditObjectV1(pkiWebhookID, WebhookEditObjectV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiWebhookID Number
WebhookEditObjectV1Request WebhookEditObjectV1Request

Return type

WebhookEditObjectV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

webhookGetHistoryV1

WebhookGetHistoryV1Response webhookGetHistoryV1(pkiWebhookID, eWebhookHistoryinterval)

Retrieve the logs for recent Webhook calls

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectWebhookApi();
let pkiWebhookID = 56; // Number | 
let eWebhookHistoryinterval = "eWebhookHistoryinterval_example"; // String | The number of days to return
apiInstance.webhookGetHistoryV1(pkiWebhookID, eWebhookHistoryinterval, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiWebhookID Number
eWebhookHistoryinterval String The number of days to return

Return type

WebhookGetHistoryV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

webhookGetListV1

WebhookGetListV1Response webhookGetListV1(opts)

Retrieve Webhook list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eWebhookModule | Ezsign<br>Management | | eWebhookEzsignevent | DocumentCompleted<br>FolderCompleted | | eWebhookManagementevent | UserCreated |

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectWebhookApi();
let opts = {
  'eOrderBy': "eOrderBy_example", // String | Specify how you want the results to be sorted
  'iRowMax': 10000, // Number | 
  'iRowOffset': 0, // Number | 
  'Accept_Language': new EZmaxApiDefinitionFull.HeaderAcceptLanguage(), // HeaderAcceptLanguage | 
  'sFilter': "sFilter_example" // String | 
};
apiInstance.webhookGetListV1(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
eOrderBy String Specify how you want the results to be sorted [optional]
iRowMax Number [optional] [default to 10000]
iRowOffset Number [optional] [default to 0]
Accept_Language HeaderAcceptLanguage [optional]
sFilter String [optional]

Return type

WebhookGetListV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

webhookGetObjectV2

WebhookGetObjectV2Response webhookGetObjectV2(pkiWebhookID)

Retrieve an existing Webhook

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectWebhookApi();
let pkiWebhookID = 56; // Number | 
apiInstance.webhookGetObjectV2(pkiWebhookID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiWebhookID Number

Return type

WebhookGetObjectV2Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

webhookTestV1

WebhookTestV1Response webhookTestV1(pkiWebhookID, body)

Test the Webhook by calling the Url

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectWebhookApi();
let pkiWebhookID = 56; // Number | 
let body = {key: null}; // Object | 
apiInstance.webhookTestV1(pkiWebhookID, body, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiWebhookID Number
body Object

Return type

WebhookTestV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json