Call us toll-free @ 888-497-7898
API Call Information
area: api
action: getwebhooks
API Arguments
API URL Example
https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=api&action=getwebhooks
API Response
XML Response
<response>
<webhook>
<id>3</id>
<url><![CDATA[https://www.mysite.com/webhook.php]]></url>
<hooktype>unsubscribe</hooktype>
<enabled>0</enabled>
<fulllistdata>0</fulllistdata>
<failures>0</failures>
<httperrorcode>0</httperrorcode>
<datecreated>December 09, 2022, 09:46 pm</datecreated>
</webhook>
<webhook>
<id>2</id>
<url><![CDATA[https://www.mysite.com/webhook.php]]></url>
<hooktype>click</hooktype>
<enabled>0</enabled>
<fulllistdata>1</fulllistdata>
<failures>0</failures>
<httperrorcode>0</httperrorcode>
<datecreated>December 09, 2022, 09:46 pm</datecreated>
</webhook>
<webhook>
<id>1</id>
<url><![CDATA[https://www.mysite.com/webhook.php]]></url>
<hooktype>open</hooktype>
<enabled>0</enabled>
<fulllistdata>1</fulllistdata>
<failures>0</failures>
<httperrorcode>0</httperrorcode>
<datecreated>December 09, 2022, 09:46 pm</datecreated>
</webhook>
</response>
JSON Response
{
"webhook": [
{
"id": "3",
"url": "https://www.mysite.com/webhook.php",
"hooktype": "unsubscribe",
"enabled": "0",
"fulllistdata": "0",
"failures": "0",
"httperrorcode": "0",
"datecreated": "December 09, 2022, 09:46 pm"
},
{
"id": "2",
"url": "https://www.mysite.com/webhook.php",
"hooktype": "click",
"enabled": "0",
"fulllistdata": "1",
"failures": "0",
"httperrorcode": "0",
"datecreated": "December 09, 2022, 09:46 pm"
},
{
"id": "1",
"url": "https://www.mysite.com/webhook.php",
"hooktype": "open",
"enabled": "0",
"fulllistdata": "1",
"failures": "0",
"httperrorcode": "0",
"datecreated": "December 09, 2022, 09:46 pm"
}
]
}