StreamPayImplementing custom webhooks
StreamPay checkout allows developer to setup their own webhooks to listen events such as transaction.successful, transaction.failed and run post-checkout events such as saving the transaction details to a database.
⚡ Full source code for the example webhook server available here
Setting up an Node.js server
We'll be using express.js to setup the webhook server. Go ahead and install express, dotenv
pnpm i express dotenv
If you're using TypeScript, you'll need to additional install the typings for the express module - @types/express
import express, { Request, Response } from "express";
const app = express();
app.use(express.json());
app.use(express.urlencoded({ extended: false }));
app.get("/", (_req: Request, res: Response) => {
return res.status(200).json({
message: "I'm alive!",
});
});
const port = 3000 || process.env.PORT;
app.listen(3000, () => {
console.log(`The server is running on port ${port}`);
});
Creating webhook endpoint
A webhook is an endpoint on your server that receives incoming requests regarding checkout session's transaction updates from StreamPay. Add a new POST endpoint to your server.
app.post("/webhook", async (req: Request, res: Response) => {
const headers = req.headers;
const payload = req.body;
const streampay = new StreamPay({
api_key: process.env.STREAMPAY_API_KEY!,
network: "devnet",
config: {
collect_shipping_address: false,
},
});
try {
await streampay.webhook.verify({
payload,
headers: headers as Record<string, string>,
webhook_secret: process.env.WEBHOOK_SECRET!,
});
} catch (err) {
return res.status(400).json({
message: "Invalid webhook signature",
});
}
return res.send();
});
The /webhook endpoint validates the X-StreamPay-Signature header via the webhook secret (which is returned by the webhook.register() method.