Setting up Webhooks

Webhooks are an advanced feature that allow us to notify your own web service whenever an event happens in your SMTP2GO account.

For example, you can choose for your own server to be instantly notified whenever a bounce occurs.

Setup of webhooks can be done on the 'Settings > Webhooks' page in your SMTP2GO control panel.

When a particular event listed on that page happens, our server will contact your server and provide it with details of the event.

Standard Reported Data

The listed URL will receive an HTTP (or HTTPS) post request with the following parameters:

event
   what happened: "delivered", "bounce", "spam", "unsubscribe", "resubscribe", or "reject".

An unsubscribe event happens if a recipient clicks on an unsubscribe link that you have inserted using the 'Unsubscribe Footer' available when editing your from the 'Settings > Unsubscribe Options'. 
If a recipient decides to resubscribe (using the link shown to them on the unsubscribe confirmation page), a resubscribe event will occur.
reject event happens if you attempt to send an email to a recipient that has previously hard-bounced, made a spam complaint, or unsubscribed.

time
   UTC timestamp of when the event happened.

sendtime
   UTC timestamp of when the email was sent to our server.

sender
   the email address the email was sent from.

rcpt
   the email address the email was addressed to.

auth
   the SMTP username used to send the email.

host
   the server that rejected the message (bounce only).

message
   the error message we got (where available).

context
   the context of the message (where available).

email_id
   an identifier that uniquely identifies the email, which can be used to retrieve further details of the email delivery.

bounce
   this parameter will be included for a bounce event, and will be either hard or soft, depending on how we classify the bounce type.

subject
   the subject of the email.

Securing the URL 

You can optionally secure the URL with a username/password, with formats such as the following.
The URLs given below are just examples.

https://USERNAME:PASSWORD@host.yourdomain.com/webhook/smtp2go

https://host.yourdomain.com/webhook/smtp2go?p=PASSWORD

or simply make the name of the endpoint hard to guess:

https://host.yourdomain.com/webhook/smtp2go_PASSWORD

Testing

A good way to start testing is to use RequestBin, which will let you see exactly what data we send to you. You would create a URL on their website: check the box next to "Private (only viewable from this browser)" then click the "Create a RequestBin" button. Once you have generated a URL you can then enter that URL into the Webhooks page in your SMTP2GO account.

Optional Email Headers

Custom email headers can optionally be reported along with the standard data above. You can specify the headers you wish to receive on the settings page. Note: headers are not available on most emails older than 2 months.

any_custom_header
 
 any custom header that is sent in your emails.

 

Each 'URL of web service' that you enter must follow the URI standard.
i.e.
PROTOCOL "://" USER ":" PASSWORD "@" HOST "/" PATH "?" QUERY "#" FRAGMENT

with most parts of that being optional.
PROTOCOL can be either HTTP or HTTPS.
USER and PASSWORD are only required if you choose to password protect your web service.

We send a POST (not a GET) request to your URL with the data
application/x-www-form-urlencoded in the body.

Was this article helpful?

...