361 lines
13 KiB
Markdown
361 lines
13 KiB
Markdown
|
# Brevo\Client\WebhooksApi
|
||
|
|
|
||
|
|
All URIs are relative to *https://api.brevo.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
|
||
|
|
[**exportWebhooksHistory**](WebhooksApi.md#exportWebhooksHistory) | **POST** /webhooks/export | Export all webhook events
|
||
|
|
[**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**
|
||
|
|
> \Brevo\Client\Model\CreateModel createWebhook($createWebhook)
|
||
|
|
|
||
|
|
Create a webhook
|
||
|
|
|
||
|
|
### Example
|
||
|
|
```php
|
||
|
|
<?php
|
||
|
|
require_once(__DIR__ . '/vendor/autoload.php');
|
||
|
|
|
||
|
|
// Configure API key authorization: api-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||
|
|
// Configure API key authorization: partner-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||
|
|
|
||
|
|
$apiInstance = new Brevo\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 \Brevo\Client\Model\CreateWebhook(); // \Brevo\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** | [**\Brevo\Client\Model\CreateWebhook**](../Model/CreateWebhook.md)| Values to create a webhook |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**\Brevo\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 = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||
|
|
// Configure API key authorization: partner-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||
|
|
|
||
|
|
$apiInstance = new Brevo\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)
|
||
|
|
|
||
|
|
# **exportWebhooksHistory**
|
||
|
|
> \Brevo\Client\Model\CreatedProcessId exportWebhooksHistory($exportWebhookHistory)
|
||
|
|
|
||
|
|
Export all webhook events
|
||
|
|
|
||
|
|
This endpoint will submit a request to get the history of webhooks in the CSV file. The link to download the CSV file will be sent to the webhook that was provided in the notifyURL.
|
||
|
|
|
||
|
|
### Example
|
||
|
|
```php
|
||
|
|
<?php
|
||
|
|
require_once(__DIR__ . '/vendor/autoload.php');
|
||
|
|
|
||
|
|
// Configure API key authorization: api-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||
|
|
// Configure API key authorization: partner-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||
|
|
|
||
|
|
$apiInstance = new Brevo\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
|
||
|
|
);
|
||
|
|
$exportWebhookHistory = new \Brevo\Client\Model\ExportWebhooksHistory(); // \Brevo\Client\Model\ExportWebhooksHistory | Values to submit for webhooks history
|
||
|
|
|
||
|
|
try {
|
||
|
|
$result = $apiInstance->exportWebhooksHistory($exportWebhookHistory);
|
||
|
|
print_r($result);
|
||
|
|
} catch (Exception $e) {
|
||
|
|
echo 'Exception when calling WebhooksApi->exportWebhooksHistory: ', $e->getMessage(), PHP_EOL;
|
||
|
|
}
|
||
|
|
?>
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**exportWebhookHistory** | [**\Brevo\Client\Model\ExportWebhooksHistory**](../Model/ExportWebhooksHistory.md)| Values to submit for webhooks history |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**\Brevo\Client\Model\CreatedProcessId**](../Model/CreatedProcessId.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)
|
||
|
|
|
||
|
|
# **getWebhook**
|
||
|
|
> \Brevo\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 = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||
|
|
// Configure API key authorization: partner-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||
|
|
|
||
|
|
$apiInstance = new Brevo\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
|
||
|
|
|
||
|
|
[**\Brevo\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**
|
||
|
|
> \Brevo\Client\Model\GetWebhooks getWebhooks($type, $sort)
|
||
|
|
|
||
|
|
Get all webhooks
|
||
|
|
|
||
|
|
### Example
|
||
|
|
```php
|
||
|
|
<?php
|
||
|
|
require_once(__DIR__ . '/vendor/autoload.php');
|
||
|
|
|
||
|
|
// Configure API key authorization: api-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||
|
|
// Configure API key authorization: partner-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||
|
|
|
||
|
|
$apiInstance = new Brevo\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
|
||
|
|
$sort = "desc"; // string | Sort the results in the ascending/descending order of webhook creation
|
||
|
|
|
||
|
|
try {
|
||
|
|
$result = $apiInstance->getWebhooks($type, $sort);
|
||
|
|
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]
|
||
|
|
**sort** | **string**| Sort the results in the ascending/descending order of webhook creation | [optional] [default to desc]
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**\Brevo\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 = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||
|
|
// Configure API key authorization: partner-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||
|
|
|
||
|
|
$apiInstance = new Brevo\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 \Brevo\Client\Model\UpdateWebhook(); // \Brevo\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** | [**\Brevo\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)
|
||
|
|
|