Skip to content

Inputs Overview

Inputs are the entry points for data into Relaye. They define how external systems send information to your Relaye instance for further processing and delivery.

What Are Inputs?

In Relaye, an input is a configured endpoint that receives information from external services. Each input has a unique identifier (URL or email address) that external services use to send data to Relaye.

Available Input Types

Relaye supports several input types to accommodate different sources of notifications:

Generic Webhook

The most flexible input type, accepting JSON payloads from any HTTP source. Ideal for custom applications, CI/CD pipelines, or any service that can send HTTP requests.

Learn more about Generic Webhook inputs

Email

Provides a dedicated email address that forwards received messages to your configured outputs. Perfect for services that send email notifications but don't support webhooks.

Learn more about Email inputs

Creating an Input

To create a new input:

  1. Navigate to the Inputs section in your dashboard
  2. Click New Input
  3. Select the input type that matches your notification source
  4. Configure the input with a name and any required settings
  5. Save to generate your unique input identifier (URL or email)

Input Settings

Name

Choose a descriptive name that helps you identify the purpose of this input. Good names often include the source service and the type of notifications (e.g., "GitHub CI Alerts" or "Production Server Monitoring").

Description (Optional)

Add details about what this input is used for, what kind of notifications it receives, or any other relevant information.

API Token

Each input has a unique API token that forms part of its webhook URL. This token is automatically generated when you create the input, but you can regenerate it if needed.

Warning

Regenerating an API token will invalidate the previous webhook URL. Make sure to update any services that send notifications to this input.

Managing Inputs

Viewing Input Details

Click on an input to view its details, including:

  • Webhook URL or email address
  • Recent incoming events
  • Connected outputs
  • Input configuration

Editing Inputs

You can edit an input's name and description at any time. To edit an input:

  1. Go to the input's details page
  2. Click Edit
  3. Make your changes
  4. Save

Deleting Inputs

To delete an input:

  1. Go to the input's details page
  2. Click Delete
  3. Confirm the deletion

Danger

Deleting an input will permanently remove it and all its incoming logs. Any external services sending notifications to this input will receive errors. This action cannot be undone.

Connecting Inputs to Outputs

Inputs by themselves don't forward notifications. You need to connect them to one or more outputs to define where the notifications should be sent. This is done through the Connections feature.

Testing Inputs

You can test an input by sending a sample notification to its webhook URL. For generic webhooks, use a tool like 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"}'

The webhook URL is available on the input's details page.

Monitoring Input Activity

Each input has an activity log that shows all incoming events. This log includes:

  • Timestamp of the event
  • Source IP address
  • Request headers
  • Complete payload
  • Processing status

You can view this log by clicking on an input and navigating to the "Incoming Events" section.

Best Practices

  • Use descriptive names for your inputs
  • Create separate inputs for different services or notification types
  • Regularly check the activity logs for failed webhook deliveries
  • Create templates that extract the most relevant information from the payloads
  • Consider securing sensitive webhooks with authentication (where supported)