67 lines
2.2 KiB
Markdown
67 lines
2.2 KiB
Markdown
# Brevo\Client\EventsApi
|
|
|
|
All URIs are relative to *https://api.brevo.com/v3*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**createEvent**](EventsApi.md#createEvent) | **POST** /events | Create an event
|
|
|
|
|
|
# **createEvent**
|
|
> createEvent($event)
|
|
|
|
Create an event
|
|
|
|
Create an event to track a contact's interaction.
|
|
|
|
### 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\EventsApi(
|
|
// 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
|
|
);
|
|
$event = new \Brevo\Client\Model\Event(); // \Brevo\Client\Model\Event |
|
|
|
|
try {
|
|
$apiInstance->createEvent($event);
|
|
} catch (Exception $e) {
|
|
echo 'Exception when calling EventsApi->createEvent: ', $e->getMessage(), PHP_EOL;
|
|
}
|
|
?>
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**event** | [**\Brevo\Client\Model\Event**](../Model/Event.md)| |
|
|
|
|
### 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)
|
|
|