- Website: https://getconvoy.io
- Forum: Github Discussions
- Documentation: getconvoy.io/docs
- Deploy: Install Convoy
- Slack: Join the Community
Convoy is an open source high-performance webhooks gateway used to securely ingest, persist, debug, deliver and manage millions of events reliably with rich features such as retries, rate limiting, static ips, circuit breaking, rolling secrets and more. To get started import the openapi spec into Postman or Insomnia.
Convoy provides several key features:
-
Webhooks Gateway: As a webhooks gateway, Convoy lives at the edge of your network to stream webhooks from your micoservices, and send them out to your users as well as receive webhooks from your providers and route them to the required services. With this your internal systems are never exposed to the public internet.
-
Scalability: Convoy acts as a dedicated message queue for webhooks, and was designed to be horizontally scalable. It includes several components like the
api server,workers,scheduler, andsocket serverwhich can be scaled independently to fit the need. -
Security: Convoy ships with several security features for webhooks, such as payload signing to ensure message integrity, bearer token authentication for authenticated webhook endpoints, and static ips for network environments with strict firewall rules.
-
Fan Out: Convoy is able to route an event to multiple endpoints based on the event type or payload structure.
-
Rate Limiting: While Convoy is able to ingest events at a massive rate, it throttles the delivery of these events to the endpoints at a configurable rate per endpoint.
-
Retries & Batch Retries: Convoy supports two retry algorithms; constant time and exponential backoff with jitter. Where automatic retries are not sufficient, convoy provides batch retries for endpoints are consecutively failed to process retried events.
-
Customer-Facing Dashboards: Convoy allows you to generate customer facing webhooks dashboard to embed into your applications using an iframe. On this dashboard, users can debug webhooks, retry events, add endpoints, and configure each endpoint's subscription.
-
Endpoint Failure Notifications: When endpoints consecutively fails to process events, convoy disables the endpoint and sends out a notification. Two types of notifications are supported: Email and Slack Notifications.
Installation, Getting Started
To do this make sure you have Docker 20+ installed.
# Get the code
$ git clone https://github.com/frain-dev/convoy.git
# Go to the Convoy folder
$ cd convoy
# Start Services
docker compose -f configs/local/docker-compose.yml upConvoy Cloud
Get started with our free Convoy Cloud version, request access: [email protected]
Contributing
Thank you for your interest in contributing! Please refer to CONTRIBUTING.md for guidance. For contributions to the Convoy dashboard, please refer to the web/ui directory.