Skip to content

WebhooksApi.md

Latest commit

 

History

History
249 lines (170 loc) · 7.76 KB

WebhooksApi.md

File metadata and controls

249 lines (170 loc) · 7.76 KB

SynergiTech\Cinolla\WebhooksApi

All URIs are relative to https://api.prod.cinolla.com, except if the operation defines another base path.

Method HTTP request Description
createWebhookSubscription() POST /v3/client/webhooks Create a new webhook subscription
deleteWebhookSubscription() DELETE /v3/client/webhooks/{id} Delete a webhook subscription
getWebhookSubscriptions() GET /v3/client/webhooks Returns all webhook subscriptions
updateWebhookSubscription() PATCH /v3/client/webhooks/{id} Update the active status of a webhook subscription

createWebhookSubscription()

createWebhookSubscription($webhookSubscription2): \SynergiTech\Cinolla\Model\WebhookSubscription3

Create a new webhook subscription

Example

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


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


$apiInstance = new SynergiTech\Cinolla\Api\WebhooksApi(
    // 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
);
$webhookSubscription2 = new \SynergiTech\Cinolla\Model\WebhookSubscription2(); // \SynergiTech\Cinolla\Model\WebhookSubscription2 | The webhook subscription to create

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

Parameters

Name Type Description Notes
webhookSubscription2 \SynergiTech\Cinolla\Model\WebhookSubscription2 The webhook subscription to create

Return type

\SynergiTech\Cinolla\Model\WebhookSubscription3

Authorization

ApiKeyAuth

HTTP request headers

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

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

deleteWebhookSubscription()

deleteWebhookSubscription($id)

Delete a webhook subscription

Example

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


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


$apiInstance = new SynergiTech\Cinolla\Api\WebhooksApi(
    // 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
);
$id = 'id_example'; // string

try {
    $apiInstance->deleteWebhookSubscription($id);
} catch (Exception $e) {
    echo 'Exception when calling WebhooksApi->deleteWebhookSubscription: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id string

Return type

void (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

getWebhookSubscriptions()

getWebhookSubscriptions(): \SynergiTech\Cinolla\Model\WebhookSubscription[]

Returns all webhook subscriptions

Example

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


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


$apiInstance = new SynergiTech\Cinolla\Api\WebhooksApi(
    // 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->getWebhookSubscriptions();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhooksApi->getWebhookSubscriptions: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\SynergiTech\Cinolla\Model\WebhookSubscription[]

Authorization

ApiKeyAuth

HTTP request headers

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

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

updateWebhookSubscription()

updateWebhookSubscription($id, $webhookSubscription4): \SynergiTech\Cinolla\Model\WebhookSubscription3

Update the active status of a webhook subscription

Example

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


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


$apiInstance = new SynergiTech\Cinolla\Api\WebhooksApi(
    // 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
);
$id = 'id_example'; // string
$webhookSubscription4 = new \SynergiTech\Cinolla\Model\WebhookSubscription4(); // \SynergiTech\Cinolla\Model\WebhookSubscription4 | The active flag to update

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

Parameters

Name Type Description Notes
id string
webhookSubscription4 \SynergiTech\Cinolla\Model\WebhookSubscription4 The active flag to update

Return type

\SynergiTech\Cinolla\Model\WebhookSubscription3

Authorization

ApiKeyAuth

HTTP request headers

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

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