https://github.com/cap-js/event-broker
CDS plugin providing integration with SAP Cloud Application Event Hub.
https://github.com/cap-js/event-broker
cap cds nodejs plugin
Last synced: 4 months ago
JSON representation
CDS plugin providing integration with SAP Cloud Application Event Hub.
- Host: GitHub
- URL: https://github.com/cap-js/event-broker
- Owner: cap-js
- License: apache-2.0
- Created: 2024-08-09T22:51:55.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-11-04T15:13:39.000Z (8 months ago)
- Last Synced: 2025-11-04T17:12:30.351Z (8 months ago)
- Topics: cap, cds, nodejs, plugin
- Language: JavaScript
- Homepage:
- Size: 124 KB
- Stars: 3
- Watchers: 5
- Forks: 6
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Welcome to @cap-js/event-broker
[](https://api.reuse.software/info/github.com/cap-js/event-broker)
## About this project
CDS plugin providing integration with SAP Cloud Application Event Hub (technical name: `event-broker`).
## Table of Contents
- [About this project](#about-this-project)
- [Requirements](#requirements)
- [Setup](#setup)
- [Support, Feedback, Contributing](#support-feedback-contributing)
- [Code of Conduct](#code-of-conduct)
- [Licensing](#licensing)
## Requirements
See [Getting Started](https://cap.cloud.sap/docs/get-started/in-a-nutshell) on how to jumpstart your development and grow as you go with SAP Cloud Application Programming Model (CAP).
To learn about messaging in CAP, please consult the guide on [Events & Messaging](https://cap.cloud.sap/docs/guides/messaging/).
## Setup
Install the plugin via:
```bash
npm add @cap-js/event-broker
```
Then, set the `kind` of your messaging service to `event-broker`:
```jsonc
"cds": {
"requires": {
"messaging": {
"kind": "event-broker"
}
}
}
```
The [CloudEvents](https://cloudevents.io/) format is enforced since it is required by SAP Cloud Application Event Hub.
Authentication in the SAP Cloud Application Event Hub integration is based on the [Identity Authentication service (IAS)](https://help.sap.com/docs/cloud-identity-services/cloud-identity-services/getting-started-with-identity-service-of-sap-btp) of [SAP Cloud Identity Services](https://help.sap.com/docs/cloud-identity-services).
If you are not using [IAS-based Authentication](https://cap.cloud.sap/docs/node.js/authentication#ias), you will need to trigger the loading of the IAS credentials into your app's `cds.env` via an additional `requires` entry:
```jsonc
"cds": {
"requires": {
"ias": { // any name
"vcap": {
"label": "identity"
}
}
}
}
```
For more information, please see [SAP Cloud Application Event Hub](https://help.sap.com/docs/sap-cloud-application-event-hub) in SAP Help Portal.
## Parameters
### webhookSizeLimit
To set a size limit for events accepted by the webhook, set the ``webhookSizeLimit``parameter in the ``package.json`` file in the root folder of your app, e.g.
```jsonc
"cds": {
"requires": {
"messaging": {
"kind": "event-broker",
"webhookSizeLimit": "1mb"
}
}
}
```
If the parameter is not set, the [global request body size limit](https://pages.github.tools.sap/cap/docs/node.js/cds-server#maximum-request-body-size) ``cds.env.server.body_parser.limit`` is taken into account. If this parameter is not set either, the default value of ``1mb``is used.
## Support, Feedback, Contributing
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cap-js/event-broker/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
## Security / Disclosure
If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/cap-js/event-broker/security/policy) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
## Code of Conduct
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/cap-js/.github/blob/main/CODE_OF_CONDUCT.md) at all times.
## Licensing
Copyright 2024 SAP SE or an SAP affiliate company and event-broker contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-js/event-broker).