# Event Callback URL List

Retrieve a list of all callback URL objects and their configuration settings. Whenever an action (e.g. email open) occurs, the information about it will be sent to the selected callback URL. You can then set up different automation workflows triggered by the tracked actions.

> Note: The URL provided cannot be a root URL.

Endpoint: GET /v3/REST/eventcallbackurl
Version: 1.0.0
Security: basicAuth

## Query parameters:

  - `Backup` (boolean)
    When true, will retrieve only backup callback URLs. When false, backup callback URLs will be excluded from the response.

  - `EventType` (integer)
    Retrieves only callback URL objects linked to the specified event type:

- 1 - click
- 2 - bounce
- 3 - spam
- 4 - blocked
- 5 - unsubscribe
- 6 - open
- 7 - sent

  - `Status` (string)
    Retrieves only callback URL objects with the specified status.

  - `Version` (integer)
    Retrieves only callback URL objects with the specified Version.

Possible values:

- 1 - The events are not grouped and a callback is received for each event individually.
- 2 - The events are grouped. A callback for the grouped events is received with a maximum frequency of once per second. Important to use to avoid reaching API rate limits.

## Response 200 fields (application/json):

  - `Count` (integer)
    Indicates the number of objects in the Data array.

  - `Data` (array)
    A JSON array containing a list of objects returned by this endpoint.

  - `Data.APIKeyID` (integer)
    Unique numeric ID for the API Key this callback URL is assigned to.

  - `Data.ID` (integer)
    Unique numeric ID for this callback URL.

  - `Data.Version` (integer)
    Indicates whether the events are sent one at a time to the callback URL, or are grouped.

Possible values:

- 1 - The events are not grouped and a callback is received for each event individually.
- 2 - The events are grouped. A callback for the grouped events is received with a maximum frequency of once per second. We advise to use this value to avoid reaching the API rate limits.

  - `Data.Url` (string)
    The URL used for this object.

> Note: The URL provided cannot be a root URL.

  - `Data.EventType` (string)
    The type of event that is being tracked.

Possible values:

- open
- click
- bounce
- spam
- blocked
- unsub
- sent

Default value: open

  - `Data.IsBackup` (boolean)
    Indicates whether this is a backup URL or not. The backup URL will be used in case the primary one is suspended.

  - `Data.Status` (string)
    Defines whether the callback URL is active or not.

Possible values:

- dead
- alive

  - `Total` (integer)
    Indicates the number of objects in the Data array.


## Response 400 fields

## Response 401 fields

## Response 403 fields

## Response 404 fields

## Response 429 fields

## Response 500 fields