Webhook Responses

Webhook 

When Tiny Relay sends a webhook event to your specified endpoint, the response will include the relevant event data as outlined below. To ensure you successfully receive these events, you will need to whitelist the following IP address from which Tiny Relay will send the events: 3.229.12.181. Please configure your firewall or security settings accordingly to allow traffic from this IP.

List of Webhook Events

Event	Description
SEND	Event triggered when email is sent successfully
DELIVERED	Event triggered when email gets delivered
BOUNCED	Event triggered if email gets bounced
OPEN	Event triggered when email is opened by the recipients
CLICK	Event triggered if recipients clicks on a redirect link present in the email
UNSUBSCRIBE	Event triggered if receiver clicks on the unsubscribe link
SPAM	Event triggered if email gets marked as spam

Request

application/json

Body

eventType string

Possible values: [SEND, DELIVERED, BOUNCED, OPEN, CLICK, UNSUBSCRIBE, SPAM]

Represents the type of event that has occurred.

subType string

Possible values: [HARD_BOUNCED, SOFT_BOUNCED]

Represents the sub-type of the main event. For example, in the case of a bounced event we can have hard or soft bounces.

notificationId string

A string representing Unique identification(UUID) for each webhook request

receiver string

Receiver's email address

requestId string

Request Id provided sent as response to Send Email

campaignId string

Campaign Id provided to Send Email to track the campaign. If not provided, then same as request Id

requestTime string

Time in nano seconds as string

bounceCategory string

Represents the category of bounce.

bounceDescription string

Represents the description of bounce(dsn_diag).

bounceStatus string

Represents the status of bounce(dsn_status).

Request Collapse all

Body

{
  "eventType": "BOUNCED",
  "subType": "HARD_BOUNCED",
  "notificationId": "f2362566-ac91-488e-bcd6-3c8039158666",
  "receiver": "receive@gmail.com",
  "requestId": "833c5151-5a98-4bad-a30f-7cc816352b7a",
  "campaignId": "833c5151-5a98-4bad-a30f-7cc816352b7a",
  "requestTime": "9748919598886666",
  "bounceCategory": "10",
  "bounceDescription": "Sorry, I couldn't find any host named tinyemial.com. (#5.1.2)",
  "bounceStatus": "10"
}

ResponseClear

Click the Send API Request button above and see the response here!