Testing Webhooks
How to test HTTP webhooks using MailSlurp test hooks.
MailSlurp allows the creation of email webhooks that forward emails, attachments, and new contacts directly to your server URL via HTTP/S POST. When a server responds with a 200 or 201 within 30 seconds the webhook is marked as successfully processed. If not the webhook is marked as unsuccessful and is put into a queue to be retried again every few minutes until successfully processed.
How can we test this process
Manual endpoint testing
We could use a tool like ngrok to create HTTP endpoints that redirect to a local server we are running.
Automated endpoint testing
For automated testing we can use MailSlurp @mailslurp/test-webhooks
library to setup real http endpoints that can respond with a set of responses we configure. This means we can simulate functional or non-functional webhooks and see how MailSlurp handles each.
Test webhook example
Let's see how to use the MailSlurp test webhooks library:
import fetchApi from 'isomorphic-fetch';
import { CreateWebhookOptionsEventNameEnum, MailSlurp } from 'mailslurp-client';
import {
Configuration as TestWebhookConfiguration,
CreateRulesetOptionsStrategyEnum,
DefaultApi as TestWebhookApi,
} from '@mailslurp/test-webhooks';
jest.setTimeout(60000);
const apiKey = process.env.API_KEY!!;
const mailslurp = new MailSlurp({ apiKey, fetchApi });
const testWebhooks = new TestWebhookApi(
new TestWebhookConfiguration({
basePath: 'https://devhooks.mailslurp.com',
fetchApi,
})
);
describe('NEW_EMAIL webhooks', () => {
test('can create NEW_EMAIL webhook and receive successfully', async () => {
// create an inbox, webhook, and a test endpoint
const testEndpoint = await testWebhooks.createEndpoint({});
const inbox = await mailslurp.createInbox();
const webhook = await mailslurp.webhookController.createWebhook({
createWebhookOptions: {
eventName: CreateWebhookOptionsEventNameEnum.NEW_EMAIL,
url: testEndpoint.url,
},
inboxId: inbox.id!,
});
// can see that endpoint has not received an event
const endpointHistory = await testWebhooks.getEndpointHistory({
endpointId: testEndpoint.id!,
});
expect(endpointHistory.items?.length).toEqual(0);
// send email to inbox
await mailslurp.sendEmail(inbox.id!, {
to: [inbox.emailAddress!],
subject: 'email1',
});
// can fetch the email directly
const email = await mailslurp.waitForLatestEmail(inbox.id!, 60000, true);
expect(email.subject).toEqual('email1');
// endpoint receives the payload (note the expected length to wait for)
const endpointHistory2 = await testWebhooks.getEndpointHistory({
endpointId: testEndpoint.id!,
expectedLength: 1,
});
expect(endpointHistory2.items?.length).toEqual(1);
// assert correct payload was sent to endpoint
const payload = JSON.parse(endpointHistory2.items?.[0]?.request?.body!);
expect(payload.webhookId).toEqual(webhook.id);
expect(payload.eventName).toEqual('NEW_EMAIL');
expect(payload.inboxId).toEqual(inbox.id);
expect(payload.emailId).toEqual(email.id);
expect(payload.to).toEqual([inbox.emailAddress]);
expect(payload.from).toEqual(inbox.emailAddress);
expect(payload.subject).toEqual('email1');
// can see webhook results via mailslurp
const results = await mailslurp.webhookController.getWebhookResults({
webhookId: webhook.id!,
});
expect(results.totalElements).toEqual(1);
const result = await mailslurp.webhookController.getWebhookResult({
webhookResultId: results.content?.[0]?.id!,
});
expect(result.resultType).toEqual('SUCCESS');
expect(result.responseStatus).toEqual(200);
await mailslurp.webhookController.deleteWebhook({
inboxId: inbox.id!,
webhookId: webhook.id!,
});
});
});
Testing failed webhooks
Now what about testing a failed result:
test('can create NEW_EMAIL webhook and see failed results when endpoint fails to accept payload', async () => {
// create a test endpoint that always returns a 401 error
const testEndpoint = await testWebhooks.createEndpoint({});
await testWebhooks.addEndpointRuleset({
endpointId: testEndpoint.id!,
createRulesetOptions: {
strategy: CreateRulesetOptionsStrategyEnum.SINGULAR,
responses: [
{
statusCode: 401,
},
],
},
});
// create inbox and webhook
const inbox = await mailslurp.createInbox();
const webhook = await mailslurp.webhookController.createWebhook({
inboxId: inbox.id!,
createWebhookOptions: {
eventName: CreateWebhookOptionsEventNameEnum.NEW_EMAIL,
url: testEndpoint.url,
},
});
// send email to inbox
await mailslurp.sendEmail(inbox.id!, {
to: [inbox.emailAddress!],
subject: 'email2',
});
// wait for endpoint to receive payload
const endpointHistory = await testWebhooks.getEndpointHistory({
endpointId: testEndpoint.id!,
expectedLength: 1,
});
expect(endpointHistory.items?.length).toEqual(1);
// can see webhook results via mailslurp
const results = await mailslurp.webhookController.getWebhookResults({
webhookId: webhook.id!,
});
expect(results.totalElements).toEqual(1);
const result = await mailslurp.webhookController.getWebhookResult({
webhookResultId: results.content?.[0]?.id!,
});
expect(result.resultType).toEqual('BAD_RESPONSE');
expect(result.responseStatus).toEqual(401);
await mailslurp.webhookController.deleteWebhook({
inboxId: inbox.id!,
webhookId: webhook.id!,
});
});
Related content
Golang email library
Golang Email Library for sending and receiving emails in Go over SMTP or HTTP/S.
Email for testing
Test email accounts for email testing. Alternatives to Mailinator, MailTrap, Mailosaur and more.
How to wait for Selenium to start during Codeception tests
Example tutorial for how to wait until webdriver and Selenium have started during Codeception PHP tests
Email API for email marketing and more
APIs for email marketing and social campaign testing. Send, receive, validate and test emails in code and online.
How to test an email address
Test email accounts for testing email addresses in code or online. Create fake email accounts for testing.
How to start selenium in a background process and wait for i...
Spawn Selenium server process before tests start for easier acceptance testing.
Send and receive email in Cypress JS tests with MailSlurp
Test email sign-up. password verification and more with Cypress JS and MailSlurp.
Cypress Email Plugin - Test email accounts in Javascript (an...
Use real email accounts in CypressJS to test user sign-up, email verification, and more.
Golang mail Library (SMTP)
How to send and receive emails in Go (test email addresses).
Email APIs for Java and Kotlin projects
Test email sending and receive emails without a mail server.
Java TestNG Selenium user sign up testing with real email ad...
Testing user sign up in Java using TestNG and MailSlurp test email accounts
Codeception PHP acceptance testing using real email address ...
Write acceptance tests in PHP with real email addresses using Codeception and MailSlurp
PHP Email Test Plugins: send and receive email in PHPUnit (e...
How to send and receive emails in PHPUnit tests.
PyTest email testing
Send and receive email in Pytest Python tests.
Selenium test email plugins: send and receive email in tests...
Receive emails in Java test suites using MailSlurp, Junit, and Selenium.
Receive email in PHP: using MailSlurp to send and receive em...
Test email in PHP using real email addresses
Testing authentication using real email addresses in Ruby wi...
Cucumber example project using Capybara to test user authentication using real email addresses.
Test applications with real emails using Serenity BDD, JBeha...
Email acceptance testing with Serenity and MailSlurp. Test applications with real email addresses.
.NET SpecFlow testing using MailSlurp email accounts and Sel...
How to test .NET authentication and sign-up using real email accounts with MailSlurp and SpecFlow.
Test email accounts with Jest and Puppeteer
Test email accounts in React with Jest and Puppeteer. Send and receive emails in Javascript.
Test Emails in Selenium with DotNet, CSharp and MailSlurp
Send and receive email in DotNET Nunit tests using Selenium and MailSlurp.
Test emails with Cucumber and Ruby
Generate test email accounts with Ruby and Cucumber. Test email sign-up, password verification and more.
Test user sign-up with NodeJS and WebDriver
Test email related processes like sign-up and verification using WDIO WebDriver and MailSlurp.
TestCafe end-to-end MFA testing for user sign-up and email v...
End-to-end testing with MailSlurp, NodeJS, and TestCafe.
Email wildcard catch-all for custom domains
MailSlurp custom email address guide for catch all email routing.
How To Test Emails Before You Send
There are many free tools to test emails before sending. This can help prevent spam warnings and increase deliverability...
Receive emails and attachments with Webhook Push
Receive emails with http webhooks. Webhooks let you respond to inbound email streams in real time on your server or with...
Testing OTP password link username and password for 2 factor...
Testing OTP password link username and password for 2 factor authentication (2FA)
Receiving emails
Read emails and attachments in code and tests. Wait for unread emails using long-polling or webhooks.
Test email address
Free test email address for testing emails online with web dashboard or REST API.
Testing email-related functionality with MailSlurp
Use MailSlurp to test email related functionality using real email addresses.
Testing email with Cypress test email accounts
Test email accounts for CypressJS. End-to-end testing with real email addresses using MailSlurp Cypress plugin.
Testing Webhooks
How to test HTTP webhooks using MailSlurp test hooks.
Testing Email with Cypress JS and MailSlurp
Email testing with Cypress JS