Skip to content
Kairosis

Quick Start

This guide walks you through configuring the GitHub connector and receiving a real push event.

1. Complete setup

Section titled “1. Complete setup”

Make sure you’ve followed the Installation guide and the setup wizard is complete.

2. Configure the GitHub connector

Section titled “2. Configure the GitHub connector”

Open the dashboard at http://localhost:3001/connectors and click GitHub.

On the configure page:

  1. Toggle Enabled on
  2. Enter your GitHub webhook secret (any string — keep it secure)
  3. Click Save

The page will display your webhook URL:

http://localhost:3200/webhooks/github/<token>

3. Register the webhook in GitHub

Section titled “3. Register the webhook in GitHub”

In your GitHub repository:

  1. Go to Settings → Webhooks → Add webhook
  2. Set Payload URL to your webhook URL from above
  3. Set Content type to application/json
  4. Set Secret to the same secret you entered in the dashboard
  5. Choose which events to send (or select Send me everything)
  6. Click Add webhook

4. Watch the event stream

Section titled “4. Watch the event stream”

Open http://localhost:3001/events in the dashboard.

Push a commit to your GitHub repository. Within seconds you should see a github.commit.pushed event appear in the stream.

5. Consume events downstream

Section titled “5. Consume events downstream”

Subscribe to the RabbitMQ topic exchange kairosis.topic with a routing key pattern:

// all GitHub events
channel.bindQueue(queue, 'kairosis.topic', 'github.#');


// only push events
channel.bindQueue(queue, 'kairosis.topic', 'github.commit.pushed');


// everything
channel.bindQueue(queue, 'kairosis.topic', '#');

Each message is a NormalizedEvent JSON object — see Normalized Events for the schema.

Next steps

Section titled “Next steps”