https://github.com/hookdeck/outpost
Open Source Outbound Webhooks and Event Destinations Infrastructure
https://github.com/hookdeck/outpost
amazon-eventbridge aws-sqs eventdestinations eventstream gcp-pubsub hookdeck rabbitmq redis webhooks webhooksender
Last synced: 1 day ago
JSON representation
Open Source Outbound Webhooks and Event Destinations Infrastructure
- Host: GitHub
- URL: https://github.com/hookdeck/outpost
- Owner: hookdeck
- License: apache-2.0
- Created: 2024-08-21T16:45:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-05T13:51:08.000Z (9 months ago)
- Last Synced: 2025-05-05T13:53:51.557Z (9 months ago)
- Topics: amazon-eventbridge, aws-sqs, eventdestinations, eventstream, gcp-pubsub, hookdeck, rabbitmq, redis, webhooks, webhooksender
- Language: Go
- Homepage: https://outpost.hookdeck.com/docs
- Size: 11.3 MB
- Stars: 29
- Watchers: 4
- Forks: 0
- Open Issues: 62
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - hookdeck/outpost - Open Source Outbound Webhooks and Event Destinations Infrastructure (Go)
- awesome-repositories - hookdeck/outpost - Open Source Outbound Webhooks and Event Destinations Infrastructure (Go)
- awesome - hookdeck/outpost - Open Source Outbound Webhooks and Event Destinations Infrastructure (<a name="Go"></a>Go)
README
[](#license)
[](https://goreportcard.com/report/github.com/hookdeck/outpost)
[](https://github.com/hookdeck/outpost/issues)
SDKs:
[](sdks/outpost-go/README.md)
[](sdks/outpost-typescript/README.md)
[](sdks/outpost-python/README.md)
Open Source Outbound Webhooks and Event Destinations Infrastructure
[Documentation](#documentation)
·
[Report a bug](issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=%F0%9F%90%9B+Bug+Report%3A+)
·
[Request a feature](issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=%F0%9F%9A%80+Feature%3A+)
Outpost is a self-hosted and open-source infrastructure that enables event producers to add outbound webhooks and [Event Destinations](https://eventdestinations.org?ref=github-outpost) to their platform with support for destination types such as Webhooks, Hookdeck Event Gateway, Amazon EventBridge, AWS SQS, AWS S3, GCP Pub/Sub, RabbitMQ, and Kafka.
The Outpost runtime has minimal dependencies (Redis or Redis cluster, PostgreSQL, and one of the supported message queues), is 100% backward compatible with your existing webhooks implementation, and is optimized for high-throughput, low-cost operation.
Outpost is built and maintained by [Hookdeck](https://hookdeck.com?ref=github-outpost). It's written in Go and distributed as a binary and Docker container under the Apache-2.0 license.
Read [Outpost Concepts](https://outpost.hookdeck.com/docs/concepts) to learn more about the Outpost architecture and design.
## Features
- **Event topics and topic-based subscriptions**: Supports the common publish and subscription paradigm to ease adoption and integration into existing systems.
- **Publish events via the API or a queue**: Publish events using the Outpost API or configure Outpost to read events from a publish queue.
- **At least once delivery guarantee**: Messages are guaranteed to be delivered at least once and never lost.
- **Event fanout**: A message is sent to a topic is replicated and sent to multiple endpoints. This allows for parallel processing and asynchronous event notifications.
- **Automatic and manual retries**: Configure retry strategies for event destinations and manually trigger event delivery retries via the API or user portal.
- **Multi-tenant support**: Create multiple tenants on a single Outpost deployment.
- **User portal**: Allow customers to view metrics, manage, debug, and observe their event destinations.
- **Delivery failure alerts**: Manage event delivery failure alerts.
- **OpenTelemetry**: OTel standardized traces, metrics, and logs.
- **Event destination types**: Out of the box support for Webhooks, Hookdeck Event Gateway, Amazon EventBridge, AWS SQS, AWS S3, GCP Pub/Sub, RabbitMQ, and Kafka.
- **Webhook best practices**: Opt-out webhook best practices, such as headers for idempotency, timestamp and signature, and signature rotation.
- **SDKs and MCP server**: Go, Python, and TypeScript SDK are available. Outpost also ships with an MCP server. All generated by [Speakeasy](https://speakeasy.com).
See the [Outpost Features](https://outpost.hookdeck.com/docs/features) for more information.
## Documentation
- [Overview](https://outpost.hookdeck.com/docs/overview)
- [Concepts](https://outpost.hookdeck.com/docs/concepts)
- [Quickstarts](https://outpost.hookdeck.com/docs/quickstarts)
- [Features](https://outpost.hookdeck.com/docs/features)
- [Guides](https://outpost.hookdeck.com/docs/guides)
- [API Reference](https://outpost.hookdeck.com/docs/api)
- [Configuration Reference](https://outpost.hookdeck.com/docs/references/configuration)
_The Outpost documentation is built using the [Zudoku documentation framework](https://zuplo.link/outpost)._
## Quickstart
### Deploy to Railway
[](https://railway.com/deploy/outpost-starter?referralCode=NRulS_)
Once the deployment is complete, configure your `TOPICS` environment variable to the topics supported for destination subscriptions, publishing, and routing of events. For example, `TOPICS=user.created,user.updated,user.deleted`.
Once deployed, you'll need the public Railway URL of your Outpost instance (referred to as `$OUTPOST_URL` below) and the generated `API_KEY` environment variable value to authenticate requests.
### Deploy locally with Docker
Ensure you have [Docker](https://docs.docker.com/engine/install/) installed.
Clone the Outpost repo:
```sh
git clone https://github.com/hookdeck/outpost.git
```
Navigate to `outpost/examples/docker-compose/`:
```sh
cd outpost/examples/docker-compose/
```
Create a `.env` file from the example:
```sh
cp .env.example .env
```
Update the `$API_KEY` value within the new `.env` file.
#### Redis Configuration
Outpost supports both standard Redis and cluster Redis configurations:
**Standard Redis** (default, for local development and single-node Redis):
```env
REDIS_HOST="redis"
REDIS_PORT="6379"
REDIS_TLS_ENABLED="false"
REDIS_CLUSTER_ENABLED="false"
```
**Redis Cluster** (for Redis Enterprise and managed Redis services):
```env
REDIS_HOST="your-redis-cluster.example.com"
REDIS_PORT="10000"
REDIS_TLS_ENABLED="true"
REDIS_CLUSTER_ENABLED="true"
```
For other cloud Redis services or self-hosted Redis clusters, set `REDIS_CLUSTER_ENABLED="true"` if using Redis clustering.
**Troubleshooting Redis connectivity**: Use the built-in diagnostic tool to test your Redis connection:
```sh
go run cmd/redis-debug/main.go your-redis-host 6379 password 0 [tls] [cluster]
```
See the [Redis Troubleshooting Guide](https://docs.outpost.hookdeck.com/references/troubleshooting-redis) for detailed guidance.
Start the Outpost dependencies and services:
```sh
docker-compose -f compose.yml -f compose-rabbitmq.yml -f compose-postgres.yml up
```
Outpost is running on `localhost:3333`. Use this value as your `$OUTPOST_URL`.
### Try out Outpost
> [!TIP]
> You can use shell variables to store the tenant ID and API key for easier use in the following commands:
>
> ```sh
> OUTPOST_URL=http://localhost:3333
> TENANT_ID=your_org_name
> API_KEY=your_api_key
> URL=your_webhook_url
> ```
Check the services are running:
```sh
curl $OUTPOST_URL/api/v1/healthz
```
Wait until you get a 200 response.
Create a tenant with the following command, replacing `$TENANT_ID` with a unique identifier such as "your_org_name", and the `$API_KEY` with the value you set in your `.env`:
```sh
curl --location --request PUT "$OUTPOST_URL/api/v1/tenants/$TENANT_ID" \
--header "Authorization: Bearer $API_KEY"
```
Run a local server exposed via a localtunnel or use a hosted service such as the [Hookdeck Console](https://console.hookdeck.com?ref=github-outpost) to capture webhook events.
Create a webhook destination where events will be delivered to with the following command. Again, replace `$TENANT_ID` and `$API_KEY`. Also, replace `$URL` with the webhook destinations URL:
```sh
curl --location "$OUTPOST_URL/api/v1/tenants/$TENANT_ID/destinations" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $API_KEY" \
--data '{
"type": "webhook",
"topics": ["*"],
"config": {
"url": "'"$URL"'"
}
}'
```
Publish an event, remembering to replace `$API_KEY` and `$TENANT_ID`:
```sh
curl --location "$OUTPOST_URL/api/v1/publish" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $API_KEY" \
--data '{
"tenant_id": "'"$TENANT_ID"'",
"topic": "user.created",
"eligible_for_retry": true,
"metadata": {
"meta": "data"
},
"data": {
"user_id": "userid"
}
}'
```
Check the logs on your server or your webhook capture tool for the delivered event.
Get an Outpost portal link for the tenant:
```sh
curl "$OUTPOST_URL/api/v1/tenants/$TENANT_ID/portal" \
--header "Authorization: Bearer $API_KEY"
```
The response will look something like the following:
```json
{ "redirect_url": "http://$OUTPOST_URL?token=$TOKEN" }
```
The `token` value is an API-generated JWT.
Open the `redirect_url` link to view the Outpost portal.
Continue to use the [Outpost API](https://outpost.hookdeck.com/docs/api) or the Outpost portal to add and test more destinations.
## Contributing
See [CONTRIBUTING](CONTRIBUTING.md).
## License
This repository contains Outpost, covered under the [Apache License 2.0](LICENSE), except where noted (any Outpost logos or trademarks are not covered under the Apache License, and should be explicitly noted by a LICENSE file.)