Call us toll free @ 888-497-7898

api - addwebhook

Adds a webhook to the account


API Call Information
area: api
action: addwebhook

API Arguments
Argument Data Type Required Description
url string Yes Full url to your webhook https://yoursite.com/file.php
hooktype string Yes One of the following values: open,click,unsubscribe,smsreply,smsclick,smsoptout,smtpopen,smtpclick
API Url Example:
https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=api&action=addwebhook

API Result:
XML Response JSON Response
<response>
  <success>Webhook Added</success>
  <webhookid>1</webhookid>
</response>
{
    "success": "Webhook Added",
    "webhookid": "1"
}