About Callback Events API
A callback is an asynchronous API request that originates from the API server and is sent to the client in response to a previous request sent by that client.
The API will make a POST request to the address defined in the URL with the information regarding the event of interest and share data related to that event.
Note: Only http or https protocols are supported in the Url parameter.
You can configure all the following callback events in our API. Documentation
Events | Description |
---|---|
Exports a list of contacts [Detail] | Exports a list of contacts to the desired callback url |
Import collection of contacts [Detail] | Receive the import report via callback |
Email bounces report [Detail] | Generates a new email bounces report |
Email clicks by contact report [Detail] | Generates a new email clicks by contact report |
Email clicks by URL report [Detail] | Generates a new email clicks by URL report |
Email events report [Detail] | Generates a new email events report |
Email unsubscriptions report [Detail] | Generates a new email unsubscriptions report |
Form answers report [Detail] | Generates a new form answers report |
Sends report [Detail] | Generates a new sends report |
SMS bounces report [Detail] | Generates a new SMS bounces report |
SMS events report [Detail] | Generates a new SMS events report |
Subscriptions report [Detail] | Generates a new subscriptions report |
Unsubscriptions report [Detail] | Generates a new unsubscriptions report |
The Callback Events API can return different types of events triggered by activity on E-goi. Each event response contains a unique payload object determined by its type.
Exports a list of contacts
Go to [Exports a list of contacts] documentation.
Exports a list of contacts to the desired callback url.
You will receive JSON in your callback_url a POST containing the following Payload.
Attribute name | Description |
---|---|
file | The url containing the file for download. |
Example:
{
"file":"https://example.com/{path_to_your_file}/{filename}.csv"
}
Import collection of contacts
Go to [Import collection of contacts] documentation.
Imports a collection of contacts.
You will receive in your callback_url a POST containing the import contacts report.
Attribute name | Description |
---|---|
imported | The number of imported contacts. |
updated | The number of updated contacts. |
ignored | The number of ignored contacts. |
invalid | The number of invalid contacts. |
Example:
{
"imported": 72,
"updated": 2,
"ignored": 0,
"invalid": 1
}
Generate email bounces report
Go to [generateEmailBouncesReport]
Generates a new email bounces report.
You will receive in your callback_url a POST containing the import contacts report.
Attribute name | Description |
---|---|
file | The url containing the import report data. |
Example:
{
"file":"https://example.com/{path_to_your_file}/{filename}.csv"
}
Generate email clicks by contact report
Go to [generateEmailClicksByContactReport]
Generates a new email clicks by contact report.
You will receive in your callback_url a POST containing the import contacts report.
Attribute name | Description |
---|---|
file | The url containing the import report data. |
Example:
{
"file":"https://example.com/{path_to_your_file}/{filename}.csv"
}
Generate email clicks by URL report
Go to [generateEmailClicksByUrlReport]
Generates a new email clicks by URL report.
You will receive in your callback_url a POST containing the import contacts report.
Attribute name | Description |
---|---|
file | The url containing the import report data. |
Example:
{
"file":"https://example.com/{path_to_your_file}/{filename}.csv"
}
Generate email events report
Go to [generateEmailEventsReport]
Generates a new email events report.
You will receive in your callback_url a POST containing the import contacts report.
Attribute name | Description |
---|---|
file | The url containing the import report data. |
Example:
{
"file":"https://example.com/{path_to_your_file}/{filename}.csv"
}
Generate email unsubscriptions report
Go to [generateEmailUnsubscriptionsReport]
Generates a new unsubscriptions report.
You will receive in your callback_url a POST containing the import contacts report.
Attribute name | Description |
---|---|
file | The url containing the import report data. |
Example:
{
"file":"https://example.com/{path_to_your_file}/{filename}.csv"
}
Generate Form answers report
Go to [generateFormAnswersReport]
Generates a new form answers report .
You will receive in your callback_url a POST containing the import contacts report.
Attribute name | Description |
---|---|
file | The url containing the import report data. |
Example:
{
"file":"https://example.com/{path_to_your_file}/{filename}.csv"
}
Generates sends report
Go to [generateFormAnswersReport]
Generates a new form answers report.
You will receive in your callback_url a POST containing the import contacts report.
Attribute name | Description |
---|---|
file | The url containing the import report data. |
Example:
{
"file":"https://example.com/{path_to_your_file}/{filename}.csv"
}
Generate SMS bounces report
Go to [generateEmailSmsReport]
Generates a new SMS bounces report.
You will receive in your callback_url a POST containing the import contacts report.
Attribute name | Description |
---|---|
file | The url containing the import report data. |
Example:
{
"file":"https://example.com/{path_to_your_file}/{filename}.csv"
}
Generate SMS events report
Go to [generateSmsEventsReport]
Generates a new SMS events report.
You will receive in your callback_url a POST containing the import contacts report.
Attribute name | Description |
---|---|
file | The url containing the import report data. |
Example:
{
"file":"https://example.com/{path_to_your_file}/{filename}.csv"
}
Generate subscriptions report
Go to [generateSubscriptionsReport]
Generates a new subscriptions report.
You will receive in your callback_url a POST containing the import contacts report.
Attribute name | Description |
---|---|
file | The url containing the import report data. |
Example:
{
"file":"https://example.com/{path_to_your_file}/{filename}.csv"
}
Generate unsubscriptions report
Go to [generateUnsubscriptionsReport]
Generates a new subscriptions report.
You will receive in your callback_url a POST containing the import contacts report.
Attribute name | Description |
---|---|
file | The url containing the import report data. |
Example:
{
"file":"https://example.com/{path_to_your_file}/{filename}.csv"
}