Skip to content

Latest commit

 

History

History
601 lines (424 loc) · 18.2 KB

ObjectWebhookApi.md

File metadata and controls

601 lines (424 loc) · 18.2 KB
Raw

EzmaxApi::ObjectWebhookApi

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

Method HTTP request Description
webhook_create_object_v2 POST /2/object/webhook Create a new Webhook
webhook_delete_object_v1 DELETE /1/object/webhook/{pkiWebhookID} Delete an existing Webhook
webhook_edit_object_v1 PUT /1/object/webhook/{pkiWebhookID} Edit an existing Webhook
webhook_get_history_v1 GET /1/object/webhook/{pkiWebhookID}/getHistory Retrieve the logs for recent Webhook calls
webhook_get_list_v1 GET /1/object/webhook/getList Retrieve Webhook list
webhook_get_object_v2 GET /2/object/webhook/{pkiWebhookID} Retrieve an existing Webhook
webhook_regenerate_apikey_v1 POST /1/object/webhook/{pkiWebhookID}/regenerateApikey Regenerate the Apikey
webhook_test_v1 POST /1/object/webhook/{pkiWebhookID}/test Test the Webhook by calling the Url

webhook_create_object_v2

webhook_create_object_v2(webhook_create_object_v2_request)

Create a new Webhook

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

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectWebhookApi.new
webhook_create_object_v2_request = EzmaxApi::WebhookCreateObjectV2Request.new({a_obj_webhook: [EzmaxApi::WebhookRequestCompound.new({s_webhook_description: 'Import into our system', e_webhook_module: EzmaxApi::FieldEWebhookModule::EZSIGN, s_webhook_url: 'https://www.example.com', s_webhook_emailfailed: '[email protected]', b_webhook_isactive: true, b_webhook_skipsslvalidation: false})]}) # WebhookCreateObjectV2Request | 

begin
  # Create a new Webhook
  result = api_instance.webhook_create_object_v2(webhook_create_object_v2_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectWebhookApi->webhook_create_object_v2: #{e}"
end

Using the webhook_create_object_v2_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> webhook_create_object_v2_with_http_info(webhook_create_object_v2_request)

begin
  # Create a new Webhook
  data, status_code, headers = api_instance.webhook_create_object_v2_with_http_info(webhook_create_object_v2_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WebhookCreateObjectV2Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectWebhookApi->webhook_create_object_v2_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
webhook_create_object_v2_request WebhookCreateObjectV2Request

Return type

WebhookCreateObjectV2Response

Authorization

Authorization

HTTP request headers

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

webhook_delete_object_v1

webhook_delete_object_v1(pki_webhook_id)

Delete an existing Webhook

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectWebhookApi.new
pki_webhook_id = 56 # Integer | 

begin
  # Delete an existing Webhook
  result = api_instance.webhook_delete_object_v1(pki_webhook_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectWebhookApi->webhook_delete_object_v1: #{e}"
end

Using the webhook_delete_object_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> webhook_delete_object_v1_with_http_info(pki_webhook_id)

begin
  # Delete an existing Webhook
  data, status_code, headers = api_instance.webhook_delete_object_v1_with_http_info(pki_webhook_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WebhookDeleteObjectV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectWebhookApi->webhook_delete_object_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_webhook_id Integer

Return type

WebhookDeleteObjectV1Response

Authorization

Authorization

HTTP request headers

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

webhook_edit_object_v1

webhook_edit_object_v1(pki_webhook_id, webhook_edit_object_v1_request)

Edit an existing Webhook

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectWebhookApi.new
pki_webhook_id = 56 # Integer | 
webhook_edit_object_v1_request = EzmaxApi::WebhookEditObjectV1Request.new({obj_webhook: EzmaxApi::WebhookRequestCompound.new({s_webhook_description: 'Import into our system', e_webhook_module: EzmaxApi::FieldEWebhookModule::EZSIGN, s_webhook_url: 'https://www.example.com', s_webhook_emailfailed: '[email protected]', b_webhook_isactive: true, b_webhook_skipsslvalidation: false})}) # WebhookEditObjectV1Request | 

begin
  # Edit an existing Webhook
  result = api_instance.webhook_edit_object_v1(pki_webhook_id, webhook_edit_object_v1_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectWebhookApi->webhook_edit_object_v1: #{e}"
end

Using the webhook_edit_object_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> webhook_edit_object_v1_with_http_info(pki_webhook_id, webhook_edit_object_v1_request)

begin
  # Edit an existing Webhook
  data, status_code, headers = api_instance.webhook_edit_object_v1_with_http_info(pki_webhook_id, webhook_edit_object_v1_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WebhookEditObjectV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectWebhookApi->webhook_edit_object_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_webhook_id Integer
webhook_edit_object_v1_request WebhookEditObjectV1Request

Return type

WebhookEditObjectV1Response

Authorization

Authorization

HTTP request headers

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

webhook_get_history_v1

webhook_get_history_v1(pki_webhook_id, e_webhook_historyinterval)

Retrieve the logs for recent Webhook calls

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectWebhookApi.new
pki_webhook_id = 56 # Integer | 
e_webhook_historyinterval = 'LastDay' # String | The number of days to return

begin
  # Retrieve the logs for recent Webhook calls
  result = api_instance.webhook_get_history_v1(pki_webhook_id, e_webhook_historyinterval)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectWebhookApi->webhook_get_history_v1: #{e}"
end

Using the webhook_get_history_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> webhook_get_history_v1_with_http_info(pki_webhook_id, e_webhook_historyinterval)

begin
  # Retrieve the logs for recent Webhook calls
  data, status_code, headers = api_instance.webhook_get_history_v1_with_http_info(pki_webhook_id, e_webhook_historyinterval)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WebhookGetHistoryV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectWebhookApi->webhook_get_history_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_webhook_id Integer
e_webhook_historyinterval String The number of days to return

Return type

WebhookGetHistoryV1Response

Authorization

Authorization

HTTP request headers

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

webhook_get_list_v1

webhook_get_list_v1(opts)

Retrieve Webhook list

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

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectWebhookApi.new
opts = {
  e_order_by: 'pkiWebhookID_ASC', # String | Specify how you want the results to be sorted
  i_row_max: 56, # Integer | 
  i_row_offset: 56, # Integer | 
  accept_language: EzmaxApi::HeaderAcceptLanguage::, # HeaderAcceptLanguage | 
  s_filter: 's_filter_example' # String | 
}

begin
  # Retrieve Webhook list
  result = api_instance.webhook_get_list_v1(opts)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectWebhookApi->webhook_get_list_v1: #{e}"
end

Using the webhook_get_list_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> webhook_get_list_v1_with_http_info(opts)

begin
  # Retrieve Webhook list
  data, status_code, headers = api_instance.webhook_get_list_v1_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WebhookGetListV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectWebhookApi->webhook_get_list_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
e_order_by String Specify how you want the results to be sorted [optional]
i_row_max Integer [optional]
i_row_offset Integer [optional][default to 0]
accept_language HeaderAcceptLanguage [optional]
s_filter String [optional]

Return type

WebhookGetListV1Response

Authorization

Authorization

HTTP request headers

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

webhook_get_object_v2

webhook_get_object_v2(pki_webhook_id)

Retrieve an existing Webhook

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectWebhookApi.new
pki_webhook_id = 56 # Integer | 

begin
  # Retrieve an existing Webhook
  result = api_instance.webhook_get_object_v2(pki_webhook_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectWebhookApi->webhook_get_object_v2: #{e}"
end

Using the webhook_get_object_v2_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> webhook_get_object_v2_with_http_info(pki_webhook_id)

begin
  # Retrieve an existing Webhook
  data, status_code, headers = api_instance.webhook_get_object_v2_with_http_info(pki_webhook_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WebhookGetObjectV2Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectWebhookApi->webhook_get_object_v2_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_webhook_id Integer

Return type

WebhookGetObjectV2Response

Authorization

Authorization

HTTP request headers

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

webhook_regenerate_apikey_v1

webhook_regenerate_apikey_v1(pki_webhook_id, webhook_regenerate_apikey_v1_request)

Regenerate the Apikey

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectWebhookApi.new
pki_webhook_id = 56 # Integer | 
webhook_regenerate_apikey_v1_request = EzmaxApi::WebhookRegenerateApikeyV1Request.new # WebhookRegenerateApikeyV1Request | 

begin
  # Regenerate the Apikey
  result = api_instance.webhook_regenerate_apikey_v1(pki_webhook_id, webhook_regenerate_apikey_v1_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectWebhookApi->webhook_regenerate_apikey_v1: #{e}"
end

Using the webhook_regenerate_apikey_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> webhook_regenerate_apikey_v1_with_http_info(pki_webhook_id, webhook_regenerate_apikey_v1_request)

begin
  # Regenerate the Apikey
  data, status_code, headers = api_instance.webhook_regenerate_apikey_v1_with_http_info(pki_webhook_id, webhook_regenerate_apikey_v1_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WebhookRegenerateApikeyV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectWebhookApi->webhook_regenerate_apikey_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_webhook_id Integer
webhook_regenerate_apikey_v1_request WebhookRegenerateApikeyV1Request

Return type

WebhookRegenerateApikeyV1Response

Authorization

Authorization

HTTP request headers

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

webhook_test_v1

webhook_test_v1(pki_webhook_id, body)

Test the Webhook by calling the Url

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectWebhookApi.new
pki_webhook_id = 56 # Integer | 
body = { ... } # Object | 

begin
  # Test the Webhook by calling the Url
  result = api_instance.webhook_test_v1(pki_webhook_id, body)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectWebhookApi->webhook_test_v1: #{e}"
end

Using the webhook_test_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> webhook_test_v1_with_http_info(pki_webhook_id, body)

begin
  # Test the Webhook by calling the Url
  data, status_code, headers = api_instance.webhook_test_v1_with_http_info(pki_webhook_id, body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WebhookTestV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectWebhookApi->webhook_test_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_webhook_id Integer
body Object

Return type

WebhookTestV1Response

Authorization

Authorization

HTTP request headers

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