Memberstack gives you two kinds of events:
-
In the browser: the DOM package's
onAuthChangetells your front-end code when a member logs in, signs up or logs out, or adds or removes a plan withaddPlan()orremovePlan(). -
On your server: webhooks. Memberstack sends a POST request to your endpoint when something happens to a member. Webhooks go to a server, not the browser, so the DOM package does not receive or verify them; your server does that with the
@memberstack/adminpackage.
View the full DOM Package documentation for more guidance.
1) Listening for Auth Changes in the Browser
Read the current member once on page load, then listen for changes:
// Read the current state once on page load: onAuthChange does not fire when you subscribe
const { data: member } = await memberstack.getCurrentMember();
// Then listen for changes
const { unsubscribe } = memberstack.onAuthChange((member) => {
if (member) {
// Logged in, signed up, or added or removed a plan
console.log('Member:', member.id, member.planConnections);
} else {
// Logged out
console.log('Logged out');
}
});
// Later, to stop listening
unsubscribe();
The callback receives the member object, or null after a logout. It runs after a member logs in, signs up or logs out, and after addPlan() or removePlan(). It does not run when you subscribe or when you call getCurrentMember(). onAuthChange returns an object with an unsubscribe() method. More in the DOM package docs.
2) Webhook Events
Set up webhooks in your Memberstack dashboard under Developer → Webhooks. Memberstack sends these events:
-
member.created- A member is created -
member.updated- A member's details are updated -
member.deleted- A member is deleted -
member.plan.added- A plan is added to a member -
member.plan.updated- A member's paid plan changes in Stripe, for example its status or price -
member.plan.canceled- A member's plan is canceled -
team.member.added- A member joins a team -
team.member.removed- A member leaves or is removed from a team
Every request body has the shape { event, timestamp, payload }, and member.updated and member.plan.updated can also include a reason: a list of what changed, for example ["status.changed"]. What's inside payload depends on the event:
member.created (the member's fields sit directly in payload)
{
"event": "member.created",
"timestamp": 1794916800000,
"payload": {
"id": "mem_abc123",
"auth": {
"email": "jane@example.com"
},
"metaData": {},
"customFields": {
"first-name": "Jane"
},
"verified": false,
"stripeCustomerId": null,
"planConnections": [
{
"status": "ACTIVE",
"planId": "pln_free123",
"planConnectionId": "con_abc123"
}
]
}
}
member.plan.added (plan events put the member under payload.member; paid plans also include priceId and payment in planConnection)
{
"event": "member.plan.added",
"timestamp": 1794916800000,
"payload": {
"member": {
"id": "mem_abc123",
"profileImage": null,
"email": "jane@example.com",
"metaData": {},
"customFields": {
"first-name": "Jane"
},
"verified": false,
"stripeCustomerId": null
},
"planConnection": {
"planId": "pln_free123",
"status": "ACTIVE"
}
}
}
team.member.added
{
"event": "team.member.added",
"timestamp": 1794916800000,
"payload": {
"teamId": "team_abc123",
"ownerId": "mem_owner123",
"memberId": "mem_abc123"
}
}
For every event's fields and how to test webhooks, see the Webhook Events Reference.
3) Verifying Webhooks
Before trusting a webhook, check on your server that it really came from Memberstack, with verifyWebhookSignature from the @memberstack/admin package:
// On your server (Node.js), not in the browser
const express = require('express');
const memberstackAdmin = require('@memberstack/admin');
const memberstack = memberstackAdmin.init(process.env.MEMBERSTACK_SECRET_KEY);
const app = express();
app.post('/webhook', express.json(), (req, res) => {
try {
// Returns true, or throws if the request is not from Memberstack
memberstack.verifyWebhookSignature({
headers: req.headers, // @memberstack/admin 1.8.0 or later
secret: process.env.MEMBERSTACK_WEBHOOK_SECRET, // whsec_..., from Developer → Webhooks
payload: req.body
});
} catch (error) {
return res.status(400).send('Invalid signature');
}
const { event, payload } = req.body;
// Handle the event, e.g. if (event === 'member.created') { ... }
res.sendStatus(200);
});
Pass the parsed JSON body (express.json()) unchanged. On @memberstack/admin 1.7.0 or earlier, map the headers to uppercase keys (SVIX-ID, SVIX-TIMESTAMP, SVIX-SIGNATURE) as shown in the Webhook Events Reference, or upgrade to 1.8.0.
Check out the other articles in this series:
- Getting Started with the Memberstack DOM Package (Front-end API)
- Working with Memberstack DOM Package Modals
- Managing App Data with the Memberstack DOM Package
- Member Authentication with the Memberstack DOM Package
- Member Billing and Checkout with the Memberstack DOM Package
- Member Management with the Memberstack DOM Package
- Events and Webhooks with Memberstack DOM
Comments
No comments yet. Start the conversation below.
Please sign in to leave a comment.