HTTP web server that listens to Contentstack webhooks. This is part of Contentstack DataSync
npm install @contentstack/webhook-listener
Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. Build your application frontend, and Contentstack will take care of the rest. Read More.
Contentstack DataSync lets you sync your Contentstack data with your database, enabling you to save data locally and serve content directly from your database. It is a combination of four powerful modules that is DataSync Webhook Listener, DataSync Manager, DataSync Asset Store Filesystem, DataSync Content Store — Filesystem and MongoDB.
The Contentstack Webhook Listener is an HTTP web server used to notify the module when a webhook is triggered. As soon as the webhook is triggered, the data synchronization process begins by notifying the specific module, that is, DataSync Manager.
Node.js 20+
``js
import * as listener from '@contentstack/wehbook-listener';
// Function which will get called when webhook triggered
let notify: function (data) {
}
register(notify)
// Start listener
start({
listener:{
endpoint: '/register',
basic_auth:{
user:"admin",
pass: "admin"
}
}
})
``
NOTE: Configure Contentstack webhook with public url of this webhook listener server.
Read more about Contentstack webhooks here.
| Property | DataType | Default |Description |
| :------------- | :---------- | :---------- | :---------- |
| listener.port | number | 5000| Optional. A port for starting the webhook listener. |
| listener.endpoint | string | /notify| Optional. The URL where the webhook should be triggered. |
| listener.basic_auth.user | string | -| Optional. Basic auth username. |
| listener.basic_auth.pass | string | -| Optional. Basic auth password. |
- Getting started with Contentstack DataSync
- Contentstack DataSync doc lists the configuration for different modules
You can send us an e-mail if you have any support or feature requests. Our support team is available 24/7 on the intercom. You can always get in touch and give us an opportunity to serve you better!