HyperMail.com
Call us toll-free @ 888-497-7898
HyperMail.com
Call us toll-free @ 888.497.7898

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 Response

XML Response

<response>
  <success>Webhook Added</success>
  <webhookid>1</webhookid>
</response>

JSON Response

{
    "success": "Webhook Added",
    "webhookid": "1"
}