Skip to content

Quick Start Guide

This guide will help you set up your first Relaye workflow in just a few minutes.

Overview

Setting up Relaye involves four main steps:

  1. Create an output (destination)
  2. Create an input (source)
  3. Create a connection between them
  4. Test your setup
graph LR
    subgraph "Relaye Setup Process"
        A[1. Create an Output] --> B[2. Create an Input]
        B --> C[3. Create a Connection]
        C --> D[4. Test Your Setup]
    end

Step 1: Create an Output

First, let's set up where you want your notifications to go:

  1. Navigate to the Outputs section in your dashboard
  2. Click New Output
  3. Choose an output type (e.g., Telegram, Slack, Discord)

New Output Screen

Telegram is one of the easiest outputs to set up:

  1. Select Telegram from the output types
  2. Open Telegram and add @relayebot to your chat or group
  3. Type /relayelink in the chat
  4. Click the link provided by the bot (it will take you back to Relaye)
  5. Give your output a name (e.g., "Team Alerts")
  6. Click Save

Other Output Types

For other output types, follow the specific instructions on the setup page. Each integration has different requirements:

  • Slack: Requires OAuth authorization
  • Discord: Requires webhook URL configuration
  • Email: Requires AWS SES credentials
  • Webhook: Requires a destination URL

Step 2: Create an Input

Now, let's set up where your notifications will come from:

  1. Navigate to the Inputs section
  2. Click New Input
  3. Choose an input type (Generic Webhook is a good starting point)
  4. Give your input a descriptive name (e.g., "GitHub Alerts")
  5. Save to generate your unique webhook URL

New Input Screen

After saving, you'll see your unique webhook URL. This is the URL you'll use to send notifications to Relaye.

Step 3: Create a Connection

Next, connect your input to your output:

  1. Go to the Connections section
  2. Click New Connection
  3. Select your input from the dropdown
  4. Select your output from the dropdown
  5. (Optional) Customize the template to format your notifications
  6. Save your connection

Step 4: Test Your Setup

Finally, let's make sure everything works:

  1. Send a test webhook to your input URL using curl:
curl -X POST https://your-relaye-instance/YOUR_TEAM_ID/YOUR_INPUT_TOKEN \
-H "Content-Type: application/json" \
-d '{"message": "This is a test notification from Relaye"}'
  1. Check your output channel (Telegram, Slack, etc.) to confirm you received the notification
  2. If needed, adjust your template to format the notification as desired

Test Notification

What's Next?

Now that you have your first Relaye connection set up, you can: