ObjectWebhookApi

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

Method	HTTP request	Description
webhookCreateObjectV2	POST /2/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
webhookRegenerateApikeyV1	POST /1/object/webhook/{pkiWebhookID}/regenerateApikey	Regenerate the Apikey
webhookTestV1	POST /1/object/webhook/{pkiWebhookID}/test	Test the Webhook by calling the Url

webhookCreateObjectV2

-(NSURLSessionTask*) webhookCreateObjectV2WithWebhookCreateObjectV2Request: (WebhookCreateObjectV2Request*) webhookCreateObjectV2Request
        completionHandler: (void (^)(WebhookCreateObjectV2Response* output, NSError* error)) handler;

Create a new Webhook

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

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


WebhookCreateObjectV2Request* webhookCreateObjectV2Request = [[WebhookCreateObjectV2Request alloc] init]; // 

ObjectWebhookApi*apiInstance = [[ObjectWebhookApi alloc] init];

// Create a new Webhook
[apiInstance webhookCreateObjectV2WithWebhookCreateObjectV2Request:webhookCreateObjectV2Request
          completionHandler: ^(WebhookCreateObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectWebhookApi->webhookCreateObjectV2: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
webhookCreateObjectV2Request	WebhookCreateObjectV2Request*

Return type

WebhookCreateObjectV2Response*

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]

webhookDeleteObjectV1

-(NSURLSessionTask*) webhookDeleteObjectV1WithPkiWebhookID: (NSNumber*) pkiWebhookID
        completionHandler: (void (^)(WebhookDeleteObjectV1Response* output, NSError* error)) handler;

Delete an existing Webhook

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiWebhookID = @56; // 

ObjectWebhookApi*apiInstance = [[ObjectWebhookApi alloc] init];

// Delete an existing Webhook
[apiInstance webhookDeleteObjectV1WithPkiWebhookID:pkiWebhookID
          completionHandler: ^(WebhookDeleteObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectWebhookApi->webhookDeleteObjectV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiWebhookID	NSNumber*

Return type

WebhookDeleteObjectV1Response*

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]

webhookEditObjectV1

-(NSURLSessionTask*) webhookEditObjectV1WithPkiWebhookID: (NSNumber*) pkiWebhookID
    webhookEditObjectV1Request: (WebhookEditObjectV1Request*) webhookEditObjectV1Request
        completionHandler: (void (^)(WebhookEditObjectV1Response* output, NSError* error)) handler;

Edit an existing Webhook

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiWebhookID = @56; // 
WebhookEditObjectV1Request* webhookEditObjectV1Request = [[WebhookEditObjectV1Request alloc] init]; // 

ObjectWebhookApi*apiInstance = [[ObjectWebhookApi alloc] init];

// Edit an existing Webhook
[apiInstance webhookEditObjectV1WithPkiWebhookID:pkiWebhookID
              webhookEditObjectV1Request:webhookEditObjectV1Request
          completionHandler: ^(WebhookEditObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectWebhookApi->webhookEditObjectV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiWebhookID	NSNumber*
webhookEditObjectV1Request	WebhookEditObjectV1Request*

Return type

WebhookEditObjectV1Response*

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]

webhookGetHistoryV1

-(NSURLSessionTask*) webhookGetHistoryV1WithPkiWebhookID: (NSNumber*) pkiWebhookID
    eWebhookHistoryinterval: (NSString*) eWebhookHistoryinterval
        completionHandler: (void (^)(WebhookGetHistoryV1Response* output, NSError* error)) handler;

Retrieve the logs for recent Webhook calls

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiWebhookID = @56; // 
NSString* eWebhookHistoryinterval = @"eWebhookHistoryinterval_example"; // The number of days to return

ObjectWebhookApi*apiInstance = [[ObjectWebhookApi alloc] init];

// Retrieve the logs for recent Webhook calls
[apiInstance webhookGetHistoryV1WithPkiWebhookID:pkiWebhookID
              eWebhookHistoryinterval:eWebhookHistoryinterval
          completionHandler: ^(WebhookGetHistoryV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectWebhookApi->webhookGetHistoryV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiWebhookID	NSNumber*
eWebhookHistoryinterval	NSString*	The number of days to return

Return type

WebhookGetHistoryV1Response*

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]

webhookGetListV1

-(NSURLSessionTask*) webhookGetListV1WithEOrderBy: (NSString*) eOrderBy
    iRowMax: (NSNumber*) iRowMax
    iRowOffset: (NSNumber*) iRowOffset
    acceptLanguage: (HeaderAcceptLanguage) acceptLanguage
    sFilter: (NSString*) sFilter
        completionHandler: (void (^)(WebhookGetListV1Response* output, NSError* error)) handler;

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

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSString* eOrderBy = @"eOrderBy_example"; // Specify how you want the results to be sorted (optional)
NSNumber* iRowMax = @56; //  (optional)
NSNumber* iRowOffset = @0; //  (optional) (default to @0)
HeaderAcceptLanguage acceptLanguage = [[HeaderAcceptLanguage alloc] init]; //  (optional)
NSString* sFilter = @"sFilter_example"; //  (optional)

ObjectWebhookApi*apiInstance = [[ObjectWebhookApi alloc] init];

// Retrieve Webhook list
[apiInstance webhookGetListV1WithEOrderBy:eOrderBy
              iRowMax:iRowMax
              iRowOffset:iRowOffset
              acceptLanguage:acceptLanguage
              sFilter:sFilter
          completionHandler: ^(WebhookGetListV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectWebhookApi->webhookGetListV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
eOrderBy	NSString*	Specify how you want the results to be sorted	[optional]
iRowMax	NSNumber*		[optional]
iRowOffset	NSNumber*		[optional] [default to @0]
acceptLanguage	HeaderAcceptLanguage		[optional]
sFilter	NSString*		[optional]

Return type

WebhookGetListV1Response*

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]

webhookGetObjectV2

-(NSURLSessionTask*) webhookGetObjectV2WithPkiWebhookID: (NSNumber*) pkiWebhookID
        completionHandler: (void (^)(WebhookGetObjectV2Response* output, NSError* error)) handler;

Retrieve an existing Webhook

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiWebhookID = @56; // 

ObjectWebhookApi*apiInstance = [[ObjectWebhookApi alloc] init];

// Retrieve an existing Webhook
[apiInstance webhookGetObjectV2WithPkiWebhookID:pkiWebhookID
          completionHandler: ^(WebhookGetObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectWebhookApi->webhookGetObjectV2: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiWebhookID	NSNumber*

Return type

WebhookGetObjectV2Response*

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]

webhookRegenerateApikeyV1

-(NSURLSessionTask*) webhookRegenerateApikeyV1WithPkiWebhookID: (NSNumber*) pkiWebhookID
    webhookRegenerateApikeyV1Request: (WebhookRegenerateApikeyV1Request*) webhookRegenerateApikeyV1Request
        completionHandler: (void (^)(WebhookRegenerateApikeyV1Response* output, NSError* error)) handler;

Regenerate the Apikey

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiWebhookID = @56; // 
WebhookRegenerateApikeyV1Request* webhookRegenerateApikeyV1Request = [[WebhookRegenerateApikeyV1Request alloc] init]; // 

ObjectWebhookApi*apiInstance = [[ObjectWebhookApi alloc] init];

// Regenerate the Apikey
[apiInstance webhookRegenerateApikeyV1WithPkiWebhookID:pkiWebhookID
              webhookRegenerateApikeyV1Request:webhookRegenerateApikeyV1Request
          completionHandler: ^(WebhookRegenerateApikeyV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectWebhookApi->webhookRegenerateApikeyV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiWebhookID	NSNumber*
webhookRegenerateApikeyV1Request	WebhookRegenerateApikeyV1Request*

Return type

WebhookRegenerateApikeyV1Response*

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]

webhookTestV1

-(NSURLSessionTask*) webhookTestV1WithPkiWebhookID: (NSNumber*) pkiWebhookID
    body: (NSObject*) body
        completionHandler: (void (^)(WebhookTestV1Response* output, NSError* error)) handler;

Test the Webhook by calling the Url

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiWebhookID = @56; // 
NSObject* body = NULL; // 

ObjectWebhookApi*apiInstance = [[ObjectWebhookApi alloc] init];

// Test the Webhook by calling the Url
[apiInstance webhookTestV1WithPkiWebhookID:pkiWebhookID
              body:body
          completionHandler: ^(WebhookTestV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectWebhookApi->webhookTestV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiWebhookID	NSNumber*
body	NSObject*

Return type

WebhookTestV1Response*

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]

Files

ObjectWebhookApi.md

Latest commit

History

ObjectWebhookApi.md

File metadata and controls

ObjectWebhookApi

webhookCreateObjectV2

Example

Parameters

Return type

Authorization

HTTP request headers

webhookDeleteObjectV1

Example

Parameters

Return type

Authorization

HTTP request headers

webhookEditObjectV1

Example

Parameters

Return type

Authorization

HTTP request headers

webhookGetHistoryV1

Example

Parameters

Return type

Authorization

HTTP request headers

webhookGetListV1

Example

Parameters

Return type

Authorization

HTTP request headers

webhookGetObjectV2

Example

Parameters

Return type

Authorization

HTTP request headers

webhookRegenerateApikeyV1

Example

Parameters

Return type

Authorization

HTTP request headers

webhookTestV1

Example

Parameters

Return type

Authorization

HTTP request headers