Webhook for API Logs
Get reports of all your calls made to Juvlon APIs.
You can create a webhook that allows you to receive data of various events, such as email delivered, email opened or clicked etc.
Set your Webhook URL
This facility is currently being worked upon. In the meantime, please contact Juvlon Support to set your webhook URL.
Webhook Reporting Format
JSON format of the reporting data that your webhook will receive:
[{ "API_CALL_ID":"56", "EVENT":"Delivered", "FROM_ADDRESS":"", "TO_EMAIL":"example@test.com", "SUBSCRIBER_ID":"567", "RESPONSE_CODE":"418", "DESCRIPTION":"", "DATE_TIME":"2019-05-09 16:36:01", "CLIENT_ID":"70523", "CUSTOM_FIELD":"Text custom Field", "USER_SOFTWARE":"", "IP_ADDRESS":"10.142.25.248", "URL":"", "BOUNCE_TYPE":"" }, { "API_CALL_ID":"56", "EVENT":"Dropped", "FROM_ADDRESS":"", "TO_EMAIL":"example@test", "SUBSCRIBER_ID":"0", "RESPONSE_CODE":"412", "DESCRIPTION":",412,Error: Invalid recipient email address", "DATE_TIME":"2019-05-09 16:34:20", "CLIENT_ID":"70523", "CUSTOM_FIELD":"", "USER_SOFTWARE":"", "IP_ADDRESS":"52.86.139.214", "URL":"", "BOUNCE_TYPE":"" }, { "API_CALL_ID":"56", "EVENT":"Opened", "FROM_ADDRESS":"", "TO_EMAIL":"example@test.com", "SUBSCRIBER_ID":"567", "RESPONSE_CODE":"451", "DESCRIPTION":"", "DATE_TIME":"2019-05-09 16:35:30", "CLIENT_ID":"70523", "CUSTOM_FIELD":"", "USER_SOFTWARE":"Firefox", "IP_ADDRESS":"64.233.173.13", "URL":"", "BOUNCE_TYPE":"" }, { "API_CALL_ID":"56", "EVENT":"Clicked", "FROM_ADDRESS":"", "TO_EMAIL":"example@test.com", "SUBSCRIBER_ID":"567", "RESPONSE_CODE":"452", "DESCRIPTION":"", "DATE_TIME":"2019-05-09 16:35:35", "CLIENT_ID":"70523", "CUSTOM_FIELD":"", "USER_SOFTWARE":"Firefox", "IP_ADDRESS":"182.74.39.50", "URL":"http://www.linkedin.com/showcase/13449236/", "BOUNCE_TYPE":"" }, { "API_CALL_ID":"56", "EVENT":"Bounced", "FROM_ADDRESS":"", "TO_EMAIL":"example@test.com", "SUBSCRIBER_ID":"2960601", "RESPONSE_CODE":"417", "DESCRIPTION":"smtp;550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at https://support.google.com/mail/?p=NoSuchUser i1si2364173pfr.150 - gsmtp", "DATE_TIME":"2019-05-09 16:36:01", "CLIENT_ID":"70523", "CUSTOM_FIELD":"Text custom Field", "USER_SOFTWARE":"", "IP_ADDRESS":"10.142.25.248", "URL":"", "BOUNCE_TYPE":"HARD" }, { "API_CALL_ID":"59", "EVENT":"Rejected", "FROM_ADDRESS":"", "TO_EMAIL":"", "SUBSCRIBER_ID":"0", "RESPONSE_CODE":"405", "DESCRIPTION":"", "DATE_TIME":"2019-05-09 16:54:07", "CLIENT_ID":"70523", "CUSTOM_FIELD":"", "USER_SOFTWARE":"", "IP_ADDRESS":"", "URL":"", "BOUNCE_TYPE":"" }]
Arguments
Name | Type | Description | |
---|---|---|---|
API_CALL_ID | String | The number generated by the system that uniquely identifies an API call. • Generated when an API call request is received. • Returned in the response of each API call. • All further tracking and reporting of the call will contain the same API_call_id/transactionId. | |
EVENT | String | The event that occurred (for which details are being provided): • Delivered: When an email that was sent gets delivered. • Opened: When a sent email is opened by the recipient. • Clicked: When a link in a sent email is clicked on by the recipient. • Bounced: When an email bounces. • Rejected: When the entire API call (and all the requests it contains) is rejected for reasons such as account expiry, or invalid API key etc. • Dropped: When a certain email request in a call is not sent out due to that particular request being invalid. • Executed: When a certain step of an automation work-flow is executed. | |
FROM_ADDRESS | String | The email address to be used as the sender of the email. | |
TO_EMAIL | String | The recipient email address that was provided in the “to”, “cc” or “bcc” field of the httpSendMail request | |
SUBSCRIBER_ID | Int | The ID that uniquely identifies your subscriber (the recipient whose email address was provided). | |
RESPONSE_CODE | String | The response code returned by the API. Please refer to the Possible-Response-Codessection of the respective API.. | |
DESCRIPTION | String | Depending on the Event, this field may contain any additional data that needs to be provided. For example: • For a “Dropped” event: the reason why the request was dropped. • For a “Bounced” event: the bounce log received from the recipient server. • For an “Executed” event: the information regarding an automation step that was carried out. | |
DATE_TIME | String | The time when the event was logged. | |
CLIENT_ID | Int | Your Juvlon account ID. | |
CUSTOM_FIELD | String | Any customized text that you may have provided for your internal tracking. | |
USER_SOFTWARE | String | The browser that the recipient used to view your email (Firefox, Chrome etc.) | |
IP_ADDRESS | String | The IP address where the recipient viewed your email. | |
URL | String | In case of a “Clicked” event, the URL in your email that the recipient clicked on. | |
BOUNCE_TYPE | String | In case of a “Bounced” event, specifies “HARD” or “SOFT”. |