Skip to content

ObjectWebhookApi.md

Latest commit

 

History

History
590 lines (400 loc) · 18.7 KB

ObjectWebhookApi.md

File metadata and controls

590 lines (400 loc) · 18.7 KB

eZmaxAPI\ObjectWebhookApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest, except if the operation defines another base path.

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
webhookSendWebhookV1() POST /1/object/webhook/sendWebhook Emit a Webhook event
webhookTestV1() POST /1/object/webhook/{pkiWebhookID}/test Test the Webhook by calling the Url

webhookCreateObjectV2()

webhookCreateObjectV2($webhookCreateObjectV2Request): \eZmaxAPI\Model\WebhookCreateObjectV2Response

Create a new Webhook

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectWebhookApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$webhookCreateObjectV2Request = new \eZmaxAPI\Model\WebhookCreateObjectV2Request(); // \eZmaxAPI\Model\WebhookCreateObjectV2Request

try {
    $result = $apiInstance->webhookCreateObjectV2($webhookCreateObjectV2Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectWebhookApi->webhookCreateObjectV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
webhookCreateObjectV2Request \eZmaxAPI\Model\WebhookCreateObjectV2Request

Return type

\eZmaxAPI\Model\WebhookCreateObjectV2Response

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]

webhookDeleteObjectV1()

webhookDeleteObjectV1($pkiWebhookID): \eZmaxAPI\Model\WebhookDeleteObjectV1Response

Delete an existing Webhook

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectWebhookApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiWebhookID = 56; // int

try {
    $result = $apiInstance->webhookDeleteObjectV1($pkiWebhookID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectWebhookApi->webhookDeleteObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiWebhookID int

Return type

\eZmaxAPI\Model\WebhookDeleteObjectV1Response

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]

webhookEditObjectV1()

webhookEditObjectV1($pkiWebhookID, $webhookEditObjectV1Request): \eZmaxAPI\Model\WebhookEditObjectV1Response

Edit an existing Webhook

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectWebhookApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiWebhookID = 56; // int
$webhookEditObjectV1Request = new \eZmaxAPI\Model\WebhookEditObjectV1Request(); // \eZmaxAPI\Model\WebhookEditObjectV1Request

try {
    $result = $apiInstance->webhookEditObjectV1($pkiWebhookID, $webhookEditObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectWebhookApi->webhookEditObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiWebhookID int
webhookEditObjectV1Request \eZmaxAPI\Model\WebhookEditObjectV1Request

Return type

\eZmaxAPI\Model\WebhookEditObjectV1Response

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]

webhookGetHistoryV1()

webhookGetHistoryV1($pkiWebhookID, $eWebhookHistoryinterval): \eZmaxAPI\Model\WebhookGetHistoryV1Response

Retrieve the logs for recent Webhook calls

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectWebhookApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiWebhookID = 56; // int
$eWebhookHistoryinterval = 'eWebhookHistoryinterval_example'; // string | The number of days to return

try {
    $result = $apiInstance->webhookGetHistoryV1($pkiWebhookID, $eWebhookHistoryinterval);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectWebhookApi->webhookGetHistoryV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiWebhookID int
eWebhookHistoryinterval string The number of days to return

Return type

\eZmaxAPI\Model\WebhookGetHistoryV1Response

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]

webhookGetListV1()

webhookGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter): \eZmaxAPI\Model\WebhookGetListV1Response

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectWebhookApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$eOrderBy = 'eOrderBy_example'; // string | Specify how you want the results to be sorted
$iRowMax = 56; // int
$iRowOffset = 0; // int
$acceptLanguage = new \eZmaxAPI\Model\\eZmaxAPI\Model\HeaderAcceptLanguage(); // \eZmaxAPI\Model\HeaderAcceptLanguage
$sFilter = 'sFilter_example'; // string

try {
    $result = $apiInstance->webhookGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectWebhookApi->webhookGetListV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
eOrderBy string Specify how you want the results to be sorted [optional]
iRowMax int [optional]
iRowOffset int [optional] [default to 0]
acceptLanguage \eZmaxAPI\Model\HeaderAcceptLanguage [optional]
sFilter string [optional]

Return type

\eZmaxAPI\Model\WebhookGetListV1Response

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]

webhookGetObjectV2()

webhookGetObjectV2($pkiWebhookID): \eZmaxAPI\Model\WebhookGetObjectV2Response

Retrieve an existing Webhook

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectWebhookApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiWebhookID = 56; // int

try {
    $result = $apiInstance->webhookGetObjectV2($pkiWebhookID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectWebhookApi->webhookGetObjectV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiWebhookID int

Return type

\eZmaxAPI\Model\WebhookGetObjectV2Response

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]

webhookRegenerateApikeyV1()

webhookRegenerateApikeyV1($pkiWebhookID, $webhookRegenerateApikeyV1Request): \eZmaxAPI\Model\WebhookRegenerateApikeyV1Response

Regenerate the Apikey

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectWebhookApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiWebhookID = 56; // int
$webhookRegenerateApikeyV1Request = new \eZmaxAPI\Model\WebhookRegenerateApikeyV1Request(); // \eZmaxAPI\Model\WebhookRegenerateApikeyV1Request

try {
    $result = $apiInstance->webhookRegenerateApikeyV1($pkiWebhookID, $webhookRegenerateApikeyV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectWebhookApi->webhookRegenerateApikeyV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiWebhookID int
webhookRegenerateApikeyV1Request \eZmaxAPI\Model\WebhookRegenerateApikeyV1Request

Return type

\eZmaxAPI\Model\WebhookRegenerateApikeyV1Response

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]

webhookSendWebhookV1()

webhookSendWebhookV1($webhookSendWebhookV1Request): \eZmaxAPI\Model\WebhookSendWebhookV1Response

Emit a Webhook event

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectWebhookApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$webhookSendWebhookV1Request = new \eZmaxAPI\Model\WebhookSendWebhookV1Request(); // \eZmaxAPI\Model\WebhookSendWebhookV1Request

try {
    $result = $apiInstance->webhookSendWebhookV1($webhookSendWebhookV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectWebhookApi->webhookSendWebhookV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
webhookSendWebhookV1Request \eZmaxAPI\Model\WebhookSendWebhookV1Request

Return type

\eZmaxAPI\Model\WebhookSendWebhookV1Response

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]

webhookTestV1()

webhookTestV1($pkiWebhookID, $body): \eZmaxAPI\Model\WebhookTestV1Response

Test the Webhook by calling the Url

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectWebhookApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pkiWebhookID = 56; // int
$body = array('key' => new \stdClass); // object

try {
    $result = $apiInstance->webhookTestV1($pkiWebhookID, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectWebhookApi->webhookTestV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiWebhookID int
body object

Return type

\eZmaxAPI\Model\WebhookTestV1Response

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]