Overview
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 |
|---|---|---|
| REST | GET | https://[Your URL]/api/2.0/trans_callback_events/ |
| XML-RPC | Call | transactional._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
| Property | Type | Description | Required |
|---|---|---|---|
| $page | integer | The page number of the list. | no |
| $count | integer | The number of results to return per page. | no |
| $order | string | The name of the field to order the listing with. | no |
| $direction | string | The direction to order the list in: ‘asc’ or ‘desc’. | no |
| $filters | structarray | The fields to filter on. | no |
Properties
| Property | Type | Description | Example |
|---|---|---|---|
| type | string | List specific types of events. Possible values:
| $options[‘event_type’] = ‘sent’ OR $options[‘event_type’] = array(‘sent’, ‘failed’) |
| url | string | List all non-bounced events that called a specific URL. | $options[‘url’] = ‘https://www.example.com’ |
| bounced_url | string | List all bounced events that called a specific URL. | $options[‘bounced_url’] = ‘https://www.example.com’ |
| status | string | List events containing a specific status. Possible values:
|
Responses
| Type | Description |
|---|---|
| array | An array of callback events. |