EConnect\Psb\HookApi

All URIs are relative to http://localhost, except if the operation defines another base path.

Method	HTTP request	Description
getHookConfigs()	GET /api/v1/hook	Get registered environment hooks.
getHooks()	GET /api/v1/{partyId}/hook	Get registered hooks.
removeHookConfig()	DELETE /api/v1/hook/{hookId}	Delete default hook.
sendHookPing()	GET /api/v1/{partyId}/hook/ping	Send ping to hook(s).
setHookConfig()	PUT /api/v1/hook	Add or update environment hook.
subscribe()	PUT /api/v1/{partyId}/hook	Add or update hook.
unSubscribe()	DELETE /api/v1/{partyId}/hook/{hookId}	Delete hook.

`getHookConfigs()`

getHookConfigs(): \EConnect\Psb\Model\Hook[]

Get registered environment hooks.

Only for PsbManagers. Get web-hooks, mail-hooks and reverse web-hooks in a list.

Example

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


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

// Configure OAuth2 access token for authorization: Bearer
$config = EConnect\Psb\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new EConnect\Psb\Api\HookApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\EConnect\Psb\Model\Hook[]

Authorization

Subscription-Key, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getHooks()`

getHooks($party_id): \EConnect\Psb\Model\Hook[]

Get registered hooks.

Get web-hooks, mail-hooks and reverse web-hooks in a list.

Example

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


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

// Configure OAuth2 access token for authorization: Bearer
$config = EConnect\Psb\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new EConnect\Psb\Api\HookApi(
    // 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
);
$party_id = 'party_id_example'; // string | The partyId of the registered hooks.

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

Parameters

Name	Type	Description	Notes
party_id	string	The partyId of the registered hooks.

Return type

\EConnect\Psb\Model\Hook[]

Authorization

Subscription-Key, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`removeHookConfig()`

removeHookConfig($hook_id)

Delete default hook.

Only for PsbManagers. Remove default hook (unsubscribe).

Example

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


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

// Configure OAuth2 access token for authorization: Bearer
$config = EConnect\Psb\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new EConnect\Psb\Api\HookApi(
    // 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
);
$hook_id = 'hook_id_example'; // string | The hookId that is used as the id in the hook object.

try {
    $apiInstance->removeHookConfig($hook_id);
} catch (Exception $e) {
    echo 'Exception when calling HookApi->removeHookConfig: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
hook_id	string	The hookId that is used as the id in the hook object.

Return type

void (empty response body)

Authorization

Subscription-Key, Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`sendHookPing()`

sendHookPing($party_id): \EConnect\Psb\Model\Document

Send ping to hook(s).

Send test message to the registered hooks.

Example

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


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

// Configure OAuth2 access token for authorization: Bearer
$config = EConnect\Psb\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new EConnect\Psb\Api\HookApi(
    // 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
);
$party_id = 'party_id_example'; // string | The partyId where the ping must be sent to.

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

Parameters

Name	Type	Description	Notes
party_id	string	The partyId where the ping must be sent to.

Return type

\EConnect\Psb\Model\Document

Authorization

Subscription-Key, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`setHookConfig()`

setHookConfig($hook): \EConnect\Psb\Model\Hook

Add or update environment hook.

Only for PsbManagers. This hook is shared between all partyId's in your environment.

Example

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


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

// Configure OAuth2 access token for authorization: Bearer
$config = EConnect\Psb\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new EConnect\Psb\Api\HookApi(
    // 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
);
$hook = new \EConnect\Psb\Model\Hook(); // \EConnect\Psb\Model\Hook | The hook that will define the action and trigger.

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

Parameters

Name	Type	Description	Notes
hook	\EConnect\Psb\Model\Hook	The hook that will define the action and trigger.

Return type

\EConnect\Psb\Model\Hook

Authorization

Subscription-Key, Bearer

HTTP request headers

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

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

`subscribe()`

subscribe($party_id, $hook): \EConnect\Psb\Model\Hook

Add or update hook.

Subscribe hook on event topics. Use the hookId to identity the hook if you want to update.

Example

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


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

// Configure OAuth2 access token for authorization: Bearer
$config = EConnect\Psb\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new EConnect\Psb\Api\HookApi(
    // 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
);
$party_id = 'party_id_example'; // string | The partyId for the hook.
$hook = new \EConnect\Psb\Model\Hook(); // \EConnect\Psb\Model\Hook | The hook that will define the action and trigger.

try {
    $result = $apiInstance->subscribe($party_id, $hook);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HookApi->subscribe: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
party_id	string	The partyId for the hook.
hook	\EConnect\Psb\Model\Hook	The hook that will define the action and trigger.

Return type

\EConnect\Psb\Model\Hook

Authorization

Subscription-Key, Bearer

HTTP request headers

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

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

`unSubscribe()`

unSubscribe($party_id, $hook_id)

Delete hook.

Remove hook (unsubscribe).

Example

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


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

// Configure OAuth2 access token for authorization: Bearer
$config = EConnect\Psb\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new EConnect\Psb\Api\HookApi(
    // 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
);
$party_id = 'party_id_example'; // string | The partyId for the hook.
$hook_id = 'hook_id_example'; // string | The hookId that is used as the id in the hook object.

try {
    $apiInstance->unSubscribe($party_id, $hook_id);
} catch (Exception $e) {
    echo 'Exception when calling HookApi->unSubscribe: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
party_id	string	The partyId for the hook.
hook_id	string	The hookId that is used as the id in the hook object.

Return type

void (empty response body)

Authorization

Subscription-Key, Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

Files

HookApi.md

Latest commit

History

HookApi.md

File metadata and controls

EConnect\Psb\HookApi

getHookConfigs()

Example

Parameters

Return type

Authorization

HTTP request headers

getHooks()

Example

Parameters

Return type

Authorization

HTTP request headers

removeHookConfig()

Example

Parameters

Return type

Authorization

HTTP request headers

sendHookPing()

Example

Parameters

Return type

Authorization

HTTP request headers

setHookConfig()

Example

Parameters

Return type

Authorization

HTTP request headers

subscribe()

Example

Parameters

Return type

Authorization

HTTP request headers

unSubscribe()

Example

Parameters

Return type

Authorization

HTTP request headers

`getHookConfigs()`

`getHooks()`

`removeHookConfig()`

`sendHookPing()`

`setHookConfig()`

`subscribe()`

`unSubscribe()`