0byt3m1n1
Path:
/
home
/
k
/
a
/
s
/
kassiope
/
www
/
vendor
/
sendinblue
/
api-v3-sdk
/
docs
/
Api
/
[
Home
]
File: WebhooksApi.md
# SendinBlue\Client\WebhooksApi All URIs are relative to *https://api.sendinblue.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**createWebhook**](WebhooksApi.md#createWebhook) | **POST** /webhooks | Create a webhook [**deleteWebhook**](WebhooksApi.md#deleteWebhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook [**getWebhook**](WebhooksApi.md#getWebhook) | **GET** /webhooks/{webhookId} | Get a webhook details [**getWebhooks**](WebhooksApi.md#getWebhooks) | **GET** /webhooks | Get all webhooks [**updateWebhook**](WebhooksApi.md#updateWebhook) | **PUT** /webhooks/{webhookId} | Update a webhook # **createWebhook** > \SendinBlue\Client\Model\CreateModel createWebhook($createWebhook) Create a webhook ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new SendinBlue\Client\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 ); $createWebhook = new \SendinBlue\Client\Model\CreateWebhook(); // \SendinBlue\Client\Model\CreateWebhook | Values to create a webhook try { $result = $apiInstance->createWebhook($createWebhook); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhooksApi->createWebhook: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **createWebhook** | [**\SendinBlue\Client\Model\CreateWebhook**](../Model/CreateWebhook.md)| Values to create a webhook | ### Return type [**\SendinBlue\Client\Model\CreateModel**](../Model/CreateModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) # **deleteWebhook** > deleteWebhook($webhookId) Delete a webhook ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new SendinBlue\Client\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 ); $webhookId = 789; // int | Id of the webhook try { $apiInstance->deleteWebhook($webhookId); } catch (Exception $e) { echo 'Exception when calling WebhooksApi->deleteWebhook: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **webhookId** | **int**| Id of the webhook | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) # **getWebhook** > \SendinBlue\Client\Model\GetWebhook getWebhook($webhookId) Get a webhook details ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new SendinBlue\Client\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 ); $webhookId = 789; // int | Id of the webhook try { $result = $apiInstance->getWebhook($webhookId); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhooksApi->getWebhook: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **webhookId** | **int**| Id of the webhook | ### Return type [**\SendinBlue\Client\Model\GetWebhook**](../Model/GetWebhook.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) # **getWebhooks** > \SendinBlue\Client\Model\GetWebhooks getWebhooks($type) Get all webhooks ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new SendinBlue\Client\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 ); $type = "transactional"; // string | Filter on webhook type try { $result = $apiInstance->getWebhooks($type); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhooksApi->getWebhooks: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **type** | **string**| Filter on webhook type | [optional] [default to transactional] ### Return type [**\SendinBlue\Client\Model\GetWebhooks**](../Model/GetWebhooks.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) # **updateWebhook** > updateWebhook($webhookId, $updateWebhook) Update a webhook ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new SendinBlue\Client\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 ); $webhookId = 789; // int | Id of the webhook $updateWebhook = new \SendinBlue\Client\Model\UpdateWebhook(); // \SendinBlue\Client\Model\UpdateWebhook | Values to update a webhook try { $apiInstance->updateWebhook($webhookId, $updateWebhook); } catch (Exception $e) { echo 'Exception when calling WebhooksApi->updateWebhook: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **webhookId** | **int**| Id of the webhook | **updateWebhook** | [**\SendinBlue\Client\Model\UpdateWebhook**](../Model/UpdateWebhook.md)| Values to update a webhook | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)