Skip to main content

Webhook Responses

Webhook

These are the API calls made to your public API to inform you of occurence of events mentioned below.

How do they work?​

Whenver an event from the list mentioned below occurs, a webhook response is send to the public API you provided at the time of onboarding.

When is a webhook called​

EventDescription
SENDEvent triggered when email is sent successfully
DELIVEREDEvent triggered when email gets delivered
BOUNCEDEvent triggered if email gets bounced
OPENEvent triggered when email is opened by the recipients
CLICKEvent triggered if recipients clicks on a redirect link present in the email
UNSUBSCRIBEEvent triggered if receiver clicks on the unsubscribe link
SPAMEvent triggered if email gets marked as spam

Request​

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).

Loading...