- Website: https://getconvoy.io
- Forum: Convoy Community
- Documentation: docs.getconvoy.io
- Deploy: Install Convoy
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.
Convoy provides several key features:
-
Webhooks Gateway: As a webhooks gateway, Convoy lives at the edge of your network to stream webhooks from your microservices, 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 two components,
serverandagent, which 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, OAuth2 and mTLS for endpoints that require them, 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 that have 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 fail to process events, convoy disables the endpoint and sends out a notification. Email, Slack, and Microsoft Teams are supported.
-
Search: Find events by id, type, source, or idempotency key, or paste JSON to search the payload. Results stay in the date range you already have open.
-
Filters & Transforms: Subscriptions can filter on body, headers, query, and path, and run a JS transform before delivery. Events that do not match are dropped.
-
Dynamic Endpoints: Register one endpoint with a URL template and Convoy fills in the destination per event.
POST /events/dynamiccan wait until the event is matched before it returns 201. -
Circuit Breaking: Convoy opens the circuit when an endpoint fails consecutively, then probes it before sending traffic again.
-
SDKs: Go, Python, JavaScript, Ruby, PHP, and Java clients are generated from the OpenAPI spec. Signature verification is hand-written and shared across languages.
-
Teams: Invite people to an organisation and assign roles. Google SSO is available when it is enabled on the instance.
-
Postgres Queue: The delivery queue can run on Postgres instead of Redis. This is experimental and needs a license.
-
Self-Hosted Premium: Add a license key to enable paid features on your own instance. Community stays free for one user, one organisation, and two projects.
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.