Why?

We've been designing a streamlined approach to handling incoming events that is easy to get right and hard to get wrong. This PR has the initial implementation of this new system.

NOTE: final names for classes / methods are still being gaveled, so don't worry about those for now. Weigh in on this doc if you have strong feelings there!

The only other pending item is to add a method to allow handling a webhook without verifying the signature. This is good for testing and for Event Bridge, which doesn't use the signature-based verification. Otherwise, this is ready for review.

What?

• add EventHandler class
• add event handler constructor on StripeClient
• add tests
• add types in like 3 placese
• tweak eslint config

Example usage

const app = express();
const client = new Stripe(apiKey);
const handler = client.router(
  webhookSecret,
  async (unhandledEvent, client, details) => {
    // something...
  }
);

handler.on('v1.billing.meter.error_report_triggered', async (event) => {
  const meter = await event.fetchRelatedObject();
  console.log(`Billing Meter ${meter.display_name} had a problem`);
});

app.post(
  '/webhook',
  express.raw({type: 'application/json'}),
  async (req, res) => {
    const sig = req.headers['stripe-signature'] ?? '';
    handler.handle(req.body(), sig);
  }
);

app.listen(4242, () => console.log('Running on port 4242'));

See Also

• DEVSDK-2822
• ⚠️ Add strongly typed EventNotifications #2370