Skip to main content

Bridge Endpoint

Novu Framework requires a single HTTP endpoint (/api/novu or similar) to be exposed by your application. This endpoint is used to receive events from our Worker Engine. You can view the Bridge Endpoint as a webhook endpoint that Novu will call when it needs to retrieve contextual information for a given subscriber and notification. Using the create-novu-app command creates a Bridge application for you with a Bridge endpoint ready to go.

The serve function

We offer framework specific wrappers in form of an exported serve function that abstracts away:
  • Parsing the incoming request for GET, POST, PUT and OPTIONS requests
  • HMAC header authentication
  • Framework specific response and error handling
Currently, we offer serve functions for the following frameworks:

Writing a custom serve function

If we currently don’t support your framework, you can write a custom serve function like the following example: