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

WebhookCreateObjectV2Response webhook_create_object_v2(webhook_create_object_v2_request)

Create a new Webhook

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

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.webhook_create_object_v2_request import WebhookCreateObjectV2Request
from eZmaxApi.models.webhook_create_object_v2_response import WebhookCreateObjectV2Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectWebhookApi(api_client)
    webhook_create_object_v2_request = eZmaxApi.WebhookCreateObjectV2Request() # WebhookCreateObjectV2Request | 

    try:
        # Create a new Webhook
        api_response = api_instance.webhook_create_object_v2(webhook_create_object_v2_request)
        print("The response of ObjectWebhookApi->webhook_create_object_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectWebhookApi->webhook_create_object_v2: %s\n" % e)

Parameters

Name	Type	Description	Notes
webhook_create_object_v2_request	WebhookCreateObjectV2Request

Return type

WebhookCreateObjectV2Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Successful response	-

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

webhook_delete_object_v1

WebhookDeleteObjectV1Response webhook_delete_object_v1(pki_webhook_id)

Delete an existing Webhook

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.webhook_delete_object_v1_response import WebhookDeleteObjectV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectWebhookApi(api_client)
    pki_webhook_id = 56 # int | 

    try:
        # Delete an existing Webhook
        api_response = api_instance.webhook_delete_object_v1(pki_webhook_id)
        print("The response of ObjectWebhookApi->webhook_delete_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectWebhookApi->webhook_delete_object_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_webhook_id	int

Return type

WebhookDeleteObjectV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

webhook_edit_object_v1

WebhookEditObjectV1Response webhook_edit_object_v1(pki_webhook_id, webhook_edit_object_v1_request)

Edit an existing Webhook

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.webhook_edit_object_v1_request import WebhookEditObjectV1Request
from eZmaxApi.models.webhook_edit_object_v1_response import WebhookEditObjectV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectWebhookApi(api_client)
    pki_webhook_id = 56 # int | 
    webhook_edit_object_v1_request = eZmaxApi.WebhookEditObjectV1Request() # WebhookEditObjectV1Request | 

    try:
        # Edit an existing Webhook
        api_response = api_instance.webhook_edit_object_v1(pki_webhook_id, webhook_edit_object_v1_request)
        print("The response of ObjectWebhookApi->webhook_edit_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectWebhookApi->webhook_edit_object_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_webhook_id	int
webhook_edit_object_v1_request	WebhookEditObjectV1Request

Return type

WebhookEditObjectV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

webhook_get_history_v1

WebhookGetHistoryV1Response webhook_get_history_v1(pki_webhook_id, e_webhook_historyinterval)

Retrieve the logs for recent Webhook calls

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.webhook_get_history_v1_response import WebhookGetHistoryV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectWebhookApi(api_client)
    pki_webhook_id = 56 # int | 
    e_webhook_historyinterval = 'e_webhook_historyinterval_example' # str | The number of days to return

    try:
        # Retrieve the logs for recent Webhook calls
        api_response = api_instance.webhook_get_history_v1(pki_webhook_id, e_webhook_historyinterval)
        print("The response of ObjectWebhookApi->webhook_get_history_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectWebhookApi->webhook_get_history_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_webhook_id	int
e_webhook_historyinterval	str	The number of days to return

Return type

WebhookGetHistoryV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
429	Too Many Requests	-

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

webhook_get_list_v1

WebhookGetListV1Response webhook_get_list_v1(e_order_by=e_order_by, i_row_max=i_row_max, i_row_offset=i_row_offset, accept_language=accept_language, s_filter=s_filter)

Retrieve Webhook list

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

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage
from eZmaxApi.models.webhook_get_list_v1_response import WebhookGetListV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectWebhookApi(api_client)
    e_order_by = 'e_order_by_example' # str | Specify how you want the results to be sorted (optional)
    i_row_max = 56 # int |  (optional)
    i_row_offset = 0 # int |  (optional) (default to 0)
    accept_language = eZmaxApi.HeaderAcceptLanguage() # HeaderAcceptLanguage |  (optional)
    s_filter = 's_filter_example' # str |  (optional)

    try:
        # Retrieve Webhook list
        api_response = api_instance.webhook_get_list_v1(e_order_by=e_order_by, i_row_max=i_row_max, i_row_offset=i_row_offset, accept_language=accept_language, s_filter=s_filter)
        print("The response of ObjectWebhookApi->webhook_get_list_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectWebhookApi->webhook_get_list_v1: %s\n" % e)

Parameters

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

Return type

WebhookGetListV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
406	The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header "Accept: application/json" but the function can only return "Content-type: image/png"	-

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

webhook_get_object_v2

WebhookGetObjectV2Response webhook_get_object_v2(pki_webhook_id)

Retrieve an existing Webhook

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.webhook_get_object_v2_response import WebhookGetObjectV2Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectWebhookApi(api_client)
    pki_webhook_id = 56 # int | 

    try:
        # Retrieve an existing Webhook
        api_response = api_instance.webhook_get_object_v2(pki_webhook_id)
        print("The response of ObjectWebhookApi->webhook_get_object_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectWebhookApi->webhook_get_object_v2: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_webhook_id	int

Return type

WebhookGetObjectV2Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

webhook_regenerate_apikey_v1

WebhookRegenerateApikeyV1Response webhook_regenerate_apikey_v1(pki_webhook_id, webhook_regenerate_apikey_v1_request)

Regenerate the Apikey

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.webhook_regenerate_apikey_v1_request import WebhookRegenerateApikeyV1Request
from eZmaxApi.models.webhook_regenerate_apikey_v1_response import WebhookRegenerateApikeyV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectWebhookApi(api_client)
    pki_webhook_id = 56 # int | 
    webhook_regenerate_apikey_v1_request = eZmaxApi.WebhookRegenerateApikeyV1Request() # WebhookRegenerateApikeyV1Request | 

    try:
        # Regenerate the Apikey
        api_response = api_instance.webhook_regenerate_apikey_v1(pki_webhook_id, webhook_regenerate_apikey_v1_request)
        print("The response of ObjectWebhookApi->webhook_regenerate_apikey_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectWebhookApi->webhook_regenerate_apikey_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_webhook_id	int
webhook_regenerate_apikey_v1_request	WebhookRegenerateApikeyV1Request

Return type

WebhookRegenerateApikeyV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

webhook_test_v1

WebhookTestV1Response webhook_test_v1(pki_webhook_id, body)

Test the Webhook by calling the Url

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.webhook_test_v1_response import WebhookTestV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectWebhookApi(api_client)
    pki_webhook_id = 56 # int | 
    body = None # object | 

    try:
        # Test the Webhook by calling the Url
        api_response = api_instance.webhook_test_v1(pki_webhook_id, body)
        print("The response of ObjectWebhookApi->webhook_test_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectWebhookApi->webhook_test_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_webhook_id	int
body	object

Return type

WebhookTestV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

Files

ObjectWebhookApi.md

Latest commit

History

ObjectWebhookApi.md

File metadata and controls

eZmaxApi.ObjectWebhookApi

webhook_create_object_v2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

webhook_delete_object_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

webhook_edit_object_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

webhook_get_history_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

webhook_get_list_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

webhook_get_object_v2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

webhook_regenerate_apikey_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

webhook_test_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details