Skip to content

Latest commit

 

History

History
272 lines (188 loc) · 10 KB

ObjectWebhookAPI.md

File metadata and controls

272 lines (188 loc) · 10 KB
Raw

ObjectWebhookAPI

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

Method HTTP request Description
ObjectWebhookAPI_webhookCreateObjectV2 POST /2/object/webhook Create a new Webhook
ObjectWebhookAPI_webhookDeleteObjectV1 DELETE /1/object/webhook/{pkiWebhookID} Delete an existing Webhook
ObjectWebhookAPI_webhookEditObjectV1 PUT /1/object/webhook/{pkiWebhookID} Edit an existing Webhook
ObjectWebhookAPI_webhookGetHistoryV1 GET /1/object/webhook/{pkiWebhookID}/getHistory Retrieve the logs for recent Webhook calls
ObjectWebhookAPI_webhookGetListV1 GET /1/object/webhook/getList Retrieve Webhook list
ObjectWebhookAPI_webhookGetObjectV2 GET /2/object/webhook/{pkiWebhookID} Retrieve an existing Webhook
ObjectWebhookAPI_webhookRegenerateApikeyV1 POST /1/object/webhook/{pkiWebhookID}/regenerateApikey Regenerate the Apikey
ObjectWebhookAPI_webhookTestV1 POST /1/object/webhook/{pkiWebhookID}/test Test the Webhook by calling the Url

ObjectWebhookAPI_webhookCreateObjectV2

// Create a new Webhook
//
// The endpoint allows to create one or many elements at once.
//
webhook_create_object_v2_response_t* ObjectWebhookAPI_webhookCreateObjectV2(apiClient_t *apiClient, webhook_create_object_v2_request_t *webhook_create_object_v2_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
webhook_create_object_v2_request webhook_create_object_v2_request_t *

Return type

webhook_create_object_v2_response_t *

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ObjectWebhookAPI_webhookDeleteObjectV1

// Delete an existing Webhook
//
// 
//
webhook_delete_object_v1_response_t* ObjectWebhookAPI_webhookDeleteObjectV1(apiClient_t *apiClient, int *pkiWebhookID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiWebhookID int *

Return type

webhook_delete_object_v1_response_t *

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ObjectWebhookAPI_webhookEditObjectV1

// Edit an existing Webhook
//
// 
//
webhook_edit_object_v1_response_t* ObjectWebhookAPI_webhookEditObjectV1(apiClient_t *apiClient, int *pkiWebhookID, webhook_edit_object_v1_request_t *webhook_edit_object_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiWebhookID int *
webhook_edit_object_v1_request webhook_edit_object_v1_request_t *

Return type

webhook_edit_object_v1_response_t *

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ObjectWebhookAPI_webhookGetHistoryV1

// Retrieve the logs for recent Webhook calls
//
// 
//
webhook_get_history_v1_response_t* ObjectWebhookAPI_webhookGetHistoryV1(apiClient_t *apiClient, int *pkiWebhookID, ezmax_api_definition__full_webhookGetHistoryV1_eWebhookHistoryinterval_e eWebhookHistoryinterval);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiWebhookID int *
eWebhookHistoryinterval ezmax_api_definition__full_webhookGetHistoryV1_eWebhookHistoryinterval_e The number of days to return

Return type

webhook_get_history_v1_response_t *

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ObjectWebhookAPI_webhookGetListV1

// 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 |
//
webhook_get_list_v1_response_t* ObjectWebhookAPI_webhookGetListV1(apiClient_t *apiClient, ezmax_api_definition__full_webhookGetListV1_eOrderBy_e eOrderBy, int *iRowMax, int *iRowOffset, header_accept_language_e Accept_Language, char *sFilter);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
eOrderBy ezmax_api_definition__full_webhookGetListV1_eOrderBy_e Specify how you want the results to be sorted [optional]
iRowMax int * [optional]
iRowOffset int * [optional] [default to 0]
Accept_Language header_accept_language_e [optional]
sFilter char * [optional]

Return type

webhook_get_list_v1_response_t *

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ObjectWebhookAPI_webhookGetObjectV2

// Retrieve an existing Webhook
//
// 
//
webhook_get_object_v2_response_t* ObjectWebhookAPI_webhookGetObjectV2(apiClient_t *apiClient, int *pkiWebhookID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiWebhookID int *

Return type

webhook_get_object_v2_response_t *

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ObjectWebhookAPI_webhookRegenerateApikeyV1

// Regenerate the Apikey
//
// 
//
webhook_regenerate_apikey_v1_response_t* ObjectWebhookAPI_webhookRegenerateApikeyV1(apiClient_t *apiClient, int *pkiWebhookID, webhook_regenerate_apikey_v1_request_t *webhook_regenerate_apikey_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiWebhookID int *
webhook_regenerate_apikey_v1_request webhook_regenerate_apikey_v1_request_t *

Return type

webhook_regenerate_apikey_v1_response_t *

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ObjectWebhookAPI_webhookTestV1

// Test the Webhook by calling the Url
//
// 
//
webhook_test_v1_response_t* ObjectWebhookAPI_webhookTestV1(apiClient_t *apiClient, int *pkiWebhookID, object_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiWebhookID int *
body object_t *

Return type

webhook_test_v1_response_t *

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]