paysuper-webhook-notifier

README

PaySuper Webhook Notifier

PaySuper Webhook Notifier is a RabbitMQ consumer that sends the PaySuper notifications to projects.

The PaySuper system can send notifications to the project for a set of events during the flow, such as creating new accounts or transaction flow, making payouts, and so on.

In most cases, webhooks are triggered by user actions on your website or by back-end related events like a successful payment, a refund payment and other.

---

Example of notifications:

1. A request of a payment complete.
2. A request of a refund complete.

The full list of webhooks' event types.

Table of Contents

• Usage
• Contributing
• License

Usage

The application handles all configuration from the environment variables:

Environment variables:

Name	Required	Default	Description
CENTRIFUGO_URL	true	-	Centrifugo host address
CENTRIFUGO_KEY	true	-	Centrifugo API key
CENTRIFUGO_USER_CHANNEL	-	paysuper:order#%s	Name of centrifugo channel to send notifications to users. Placeholder in the end will to change to order identifier
CENTRIFUGO_ADMIN_CHANNEL	-	paysuper:admin	Name of centrifugo channel to send notifications to administrators
BROKER_ADDRESS	-	amqp://127.0.0.1:5672	RabbitMQ url address
METRICS_PORT	-	8087	Http server port for health and metrics request
REDIS_HOST	-	127.0.0.1:6379	Redis server host address
REDIS_PASSWORD	-	""	Password to access to Redis server

Contributing, Feature Requests and Support

If you like this project then you can put a ⭐ on it. It means a lot to us.

If you have an idea of how to improve PaySuper (or any of the product parts) or have general feedback, you're welcome to submit a feature request.

Chances are, you like what we have already but you may require a custom integration, a special license or something else big and specific to your needs. We're generally open to such conversations.

If you have a question and can't find the answer yourself, you can raise an issue and describe what exactly you're trying to do. We'll do our best to reply in a meaningful time.

We feel that a welcoming community is important and we ask that you follow PaySuper's Open Source Code of Conduct in all interactions with the community.

PaySuper welcomes contributions from anyone and everyone. Please refer to our contribution guide to learn more.

License

The project is available as open source under the terms of the GPL v3 License.