Get a List of Callback Events

This request will return a subset of all your transactional emails callback events. Use the page and count parameters to get the whole list. You can include the order, direction, and filter variables to affect the list you receive as request variables.


The Method

API Method
RESTGEThttp://[Your URL]/api/2.0/trans_callback_events/
XML-RPCCalltransactional._callback_events.ListTransactionalCallbackEvents
Your URL is the address of your Everlytic install.

Your method must be structured as follows:

ListTransactionalCallbackEvents(int $page, int $count, string $order, string $direction, \struct | array $filters) : array

Parameters

PropertyTypeDescriptionRequired
$pageintegerThe page number of the list.no
$countintegerThe number of results to return per page.no
$orderstringThe name of the field to order the listing with.no
$directionstringThe direction to order the list in: 'asc' or 'desc'.no
$filters\structarrayThe fields to filter on.no

Properties

PropertyTypeDescriptionExample
typestringList specific types of events.
Possible values:

  • sent

  • failed

  • bounced

  • open

  • click

$options['event_type'] = 'sent'
OR
$options['event_type'] = array('sent', 'failed')
urlstringList all non-bounced events that called a specific URL.$options['url'] = 'http://www.example.com'
bounced_urlstringList all bounced events that called a specific URL.$options['bounced_url'] = 'http://www.example.com'
statusstringList events containing a specific status.
Possible values:

  • success

  • fail

Responses

TypeDescription
arrayAn array of callback events.
Translate »