Email webhooks

Preparations

Email provider webhooks can notify Fast Events about key message events such as bounces, deliveries, opens, clicks, spam complaints and more. The names of the events differ depending on the email provider. Each request contains a JSON object with information about the event.

Some events are labeled as errors by Fast Events and can be found for the order in the Error log menu. Usually these are bounce events caused, for example, by an incorrect email address, but there can be other reasons as well. The Email menu provides an overview of the email details and all events in chronological order.

Email webhooks are not available for the Email-server type Host email, SMTP, Amazon SES API and Sparkpost.

Use the following steps to configure email webhooks:

  1. Check the Webhook checkbox in the Email Settings.

  2. Create a new Fast Events user. Choose Tools → Admin Accounts. Do not create a WordPress user yourself. Use any name (eg. webhook) and a random, non‑existent email address. No further configuration of the user is required. Click Save and store the application password in a safe place. You’ll need it later when configuring webhooks with the email provider.

  3. Log in to the mail provider used for Fast Events.

  4. Configure the webhooks. Below, it explains for each email provider how it should be configured.

Warning

All email providers offer the ability to send open events and click events. Open events are sent as soon as the email is opened, and click events are sent when the user clicks a URL in the email. If you want to receive these events, there are a couple of things to keep in mind:

  1. The number of events, especially click events, can be large. After all, a user may open an email multiple times and click on a URL several times. Each individual event results in a REST‑API call to your WordPress system.

  2. Some email clients can be configured not to send read receipts, so no open event is generated. For click events, browser ad‑blocker extensions can block the events. Therefore, there’s no guarantee that these events will be received by Fast Events.

Email providers

Brevo webhook settings

The settings can be found in the Brevo dashboard.

  1. Choose Settings → Webhook.

  2. Create a new Outbound webhook.

  3. Any name will do.

  4. The endpoint is: https://fillinyourdomain.com/wp-json/fast-events/v1/email/webhook/smtp2go

  5. The Authentication method should be Basic

  6. Use the name and the application password we created earlier as the Username and Password.

  7. The Event category should be Transactional email

  8. Choose the events you want to receive.

The following events are marked as error events: soft_bounce, hard_bounce, spam, invalid_email, deferred, blocked, error and unsubscribed. They are visible in the Error log of the order menu for a specific order or in the Error log of the Tools section.

Mailgun webhook settings

The settings can be found in the Mailgun dashboard.

  1. In the left sidebar, select Send, then choose Webhooks.

  2. Click Add webhook

  3. Choose the event you want

  4. The URL is: https://user:password@fillinyourdomain.com/wp-json/fast-events/v1/email/webhook/mailgun. Use the name and the application password we created earlier as the user and password in the URL. First remove the spaces from the application password.

  5. Repeat these steps if you want to receive more than one event type.

The following events are marked as error events: failed, complained and unsubscribed. They are visible in the Error log of the order menu for a specific order or in the Error log of the Tools section.

Mailjet webhook settings

The settings can be found in the Mailjet dashboard.

  1. Navigate to Settings → Event Tracking (or Account Settings → Webhooks).

  2. Click Add webhook

  3. The URL is: https://user:password@fillinyourdomain.com/wp-json/fast-events/v1/email/webhook/mailjet. Use the name and the application password we created earlier as the user and password in the URL. First remove the spaces from the application password.

  4. Select the events you wish to receive.

Warning

Do not use Use event grouping which is Version=2 to batch multiple events in single requests.

The following events are marked as error events: bounce, spam and blocked. They are visible in the Error log of the order menu for a specific order or in the Error log of the Tools section.

Postmark webhook settings

The settings can be found in the Postmark dashboard.

  1. Select the Server and choose Default Transactional Stream → Webhooks.

  2. Click Add webhook

  3. The URL is: https://fillinyourdomain.com/wp-json/fast-events/v1/email/webhook/postmark.

  4. Expand Custom headers and basic auth

  5. Use the name and the application password we created earlier as the Username and Password as the Basic auth credentials.

  6. Choose the events you want to receive.

The following events are marked as error events: Bounce, Spam complaint, Subscription change and Manual suppression. They are visible in the Error log of the order menu for a specific order or in the Error log of the Tools section.

Sendgrid webhook settings

The settings can be found in the Sendgrid dashboard.

  1. In the left sidebar, select Settings, then choose Mail Settings.

  2. Click Event Webhooks

  3. Click Create new webhook

  4. Any name will do.

  5. The URL is: https://user:password@fillinyourdomain.com/wp-json/fast-events/v1/email/webhook/sendgrid. Use the name and the application password we created earlier as the user and password in the URL. First remove the spaces from the application password.

  6. Select the events you wish to receive.

Warning

Do not enable Enable Signed Event Webhook or Enable OAuth.

The following events are marked as error events: Deferred, Bounce, Dropped, Spam report, Unsubscribe and Group unsubscribe. They are visible in the Error log of the order menu for a specific order or in the Error log of the Tools section.

SMTP2GO webhook settings

The settings can be found in the SMTP2GO dashboard.

  1. In the left sidebar, select Settings, then choose Webhooks.

  2. Click Add webhook

  3. The URL is: https://fillinyourdomain.com/wp-json/fast-events/v1/email/webhook/smtp2go.

  4. Select Basic for Authorization header.

  5. Add the Base64‑encoded string that consists of the username and application password. Some websites can do this encoding for you online. For example, this one.

  6. Use All users selected for Users and JSON as Output type.

  7. Select the events you wish to receive.

  8. Add the custom headers X_fast_events_event_id, X_fast_events_order_id and X_fast_events_name to Email headers. After typing each one, press Enter.

The following events are marked as error events: bounce, spam, unsubscribe, resubscribe and reject. They are visible in the Error log of the order menu for a specific order or in the Error log of the Tools section.