Skip to main content

Quickstart

Before diving into the installation process, ensure that your environment is adequately prepared. You should be operating with Go 1.20 and have access to the github.com/go-redis/redis/v8 package (version v8.11.5).

Docker Installation

Utilizing Docker for the installation simplifies the setup process, promoting a uniform operational environment.

Installation Steps:

  1. Pull the Docker Image

    docker pull koladev32/sendhooks:latest
  2. Run the Docker Image

    docker run --env REDIS_ADDRESS=<REDIS_ADDRESS:PORT> koladev32/sendhooks

Direct Binary Installation

The binary can be obtained directly from the releases page.

Installation Steps:

  1. Download the Binary

    curl -LO https://github.com/koladev32/sendhooks-engine/releases/download/v0.0.1/webhook
  2. Make the Binary Executable

    chmod +x webhook
  3. Run the Binary

    ./webhook

Examples

Here are some examples on how to start sending data to sendhooks :

const redis = require("redis");
const client = redis.createClient();

const payload = {
url: "https://webhook.site/your-endpoint",
webhookId: "12345",
data: {
key: "value",
},
secretHash: "secret",
};

client.publish("hooks", JSON.stringify(payload));
client.quit();