List webhooks
Get /settings/webhooks
Parameters:
None
Response:
Node of webhook composed by:
Name | Description | Type |
---|---|---|
id | Id of the webhook | String |
url | Webhook url | String |
description | Webhook description | String |
events | Events used for the Webhook | Array of String |
success | Number of call in success | Int |
errors | Number of call in error | Int |
createdAt | Creation date | String |
updatedAt | Update date | String |
Programming language:
Response exemple:
[ { "id": "561d21979932836f57bbb894", "url": "http://www.example.com/1444749717", "description": "Webhook description", "createdAt": "1444749719", "updatedAt": "1444749719", "success": 10, "errors": 0, "events": [ "clicked", "complaint", "delivered", "error", "hardbounced", "opened", "rejected", "softbounced", "unsubscribed" ] }, { "id": "561d21a79932badc2d674d52", "url": "http://www.example.com/1444749734", "description": "Webhook description", "createdAt": "1444749735", "updatedAt": "1444749735", "errors": 0, "success": 20, "events": [ "delivered", "opened", "clicked" ] } ]
Code example:
curl -X GET -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
require 'vendor/autoload.php'; $tipimail = new Tipimail\Tipimail('YOUR_SMTP_USERNAME', 'YOUR_API_KEY'); try { $result = $tipimail->getSettingsService()->getWebhooksService()->getAll(); var_dump($result); } catch(Tipimail\Exceptions\TipimailException $e) { echo 'Exception received :', $e->getMessage(), "\n"; }