Ajouter un webhook
Post /settings/webhooks
Paramètres :
| Nom | Description | Type | Obligatoire |
|---|---|---|---|
| url | Url à appeler lors d'un événement | String | Oui |
| description | Description du webhook | String | Oui |
| events |
Liste des événements
Evénements disponibles :
| Array | Oui |
Réponse :
Avant d'ajouter le webhook, nous testons la validité de l'url en vérifiant si nous avons un code de retour smtp 200. Sinon nous n'enregistrons pas le webhook et nous retournos un code d'erreur.
| Nom | Description | Type |
|---|---|---|
| id | Id du webhook | String |
| url | Url du webhook | String |
| description | Description du webhook | String |
| events | Evénements utilisés par le webhook | Array of String |
| success | Nombre d'appels en succès | Int |
| errors | Nombre d'appels en erreur | Int |
| createdAt | Date de création | String |
| updatedAt | Date de mise à jour | String |
Langage de programmation :
Exemple de requête :
{
"url": "http://yourwebsite.com/webhook",
"description": "my first webhook",
"events": ["delivered", "opened", "clicked"]
}
Exemple de réponse :
{
"id": "5654654v6re54v654654648c",
"url": "http://yourwebsite.com/webhook",
"description": "Webhook description",
"createdAt": 1452177334,
"updatedAt": 1452177334,
"success": 0,
"errors": 0,
"events": ["delivered", "opened", "clicked"],
"status": "success"
}
Exemple de code :
curl -X POST -d '{"url":"http://yourwebsite.com/webhook","description":"my first webhook","events":["delivered"]}' -H "Content-Type: application/json" -H "X-Tipimail-ApiUser:YOUR_SMTP_USERNAME" -H "X-Tipimail-ApiKey:YOUR_SMTP_KEY" https://api.tipimail.com/v1/settings/webhooks/add
require 'vendor/autoload.php';
$tipimail = new Tipimail\Tipimail('YOUR_SMTP_USERNAME', 'YOUR_API_KEY');
try {
$result = $tipimail->getSettingsService()->getWebhooksService()->addWithAllEvents('http://www.example.com/example', 'Description');
var_dump($result);
$events = new Tipimail\Settings\Webhooks\WebhookEvents();
$events->enableDelivered();
$events->enableHardbounced();
$result = $tipimail->getSettingsService()->getWebhooksService()->addWithSelectedEvents('http://www.example.com/example', 'Description', $events);
var_dump($result);
}
catch(Tipimail\Exceptions\TipimailException $e) {
echo 'Exception received :', $e->getMessage(), "\n";
}