Project

webhookdb

0.01
The project is in a healthy, maintained state
Replicate any API to your database with WebhookDB. WebhookDB handles webhooks and intelligently polls APIs to provide a normalized, schematized, relational copy of API data. No new APIs to learn -- just an easy-to-use CLI to set up integrations, and then you get a database connection string to access your data. WebhookDB keeps everything up to date, automatically. Explore the extensive documentation at https://docs.webhookdb.com.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

~> 6.0
~> 0.11
>= 0.8
~> 0.0
~> 3.1
~> 1.8
~> 5.4
~> 0.87
~> 2.0.0
~> 1.0.0
~> 0.21
~> 5.4
~> 2.8
~> 0.4
~> 1.12
~> 6.16
~> 1.16
~> 3.16
~> 1.5
~> 2.20
~> 1.21
~> 0.14
~> 6.4
~> 2.0
~> 13.1
~> 4.8
~> 5.75
~> 1.17
~> 10.4
~> 1.2
~> 1.3
~> 2.7
~> 0.10
 Project Readme

Latest Release Gem Version Build Tests Coverage Docs

WebhookDB

Replicate any API to your database with WebhookDB.

WebhookDB handles webhooks and intelligently polls APIs to provide a normalized, schematized, relational copy of API data.

No new APIs to learn -- just an easy-to-use CLI to set up integrations, and then you get a database connection string to access your data. WebhookDB keeps everything up to date, automatically.

WebhookDB is designed to be easily self-hosted (seriously, you can even deploy to Heroku within seconds), or used through WebhookDB Cloud.

Explore the extensive documentation at https://docs.webhookdb.com.

Quick Start

The easiest way to get started is to use the Docker Compose file, which uses the latest webhookdb image and starts up dependencies.

$ docker compose -f docker/docker-compose-demo.yml up 

Then go to http://localhost:18101/terminal, and run:

> webhookdb auth login

The demo Docker Compose file mode will automatically set up some datasets you can browse.

To replicate API data, see what is available with webhookdb services list, and set up a replicator with webhookdb integrations create.

> webhookdb services list
> webhookdb integrations create <service name>

Documentation

Visit https://docs.webhookdb.com to see the docs.

Admin

The server comes with an admin interface at /admin. Go to http://localhost:18101/admin to view it.

Deployment

WebhookDB is designed to be easy to deploy. You just need a way to run a container, some configuration, a Postgres database, and Redis.

To build a configuration file, and deploy directly to Platform-as-a-Service platforms like Heroku, visit https://webhookdb.com/deploy-builder.

License

Licensed under Apache 2.0

Copyright 2020, Lithic Technology