← Back to documentation

Getting Started

Create a target and endpoint, send a request, and read the result in Activity.

4 min read

Use this guide to create an endpoint and send the first request.

Purpose#

Use this workflow to:

  • Sign in with session-cookie authentication.
  • Create a relay target. A relay target is a saved connection to a system that receives the data.
  • Create an endpoint. An endpoint is a URL that accepts relay requests.
  • Send a request and read the outcome.

Before you start#

  • Access to /login, or to /signup if it is enabled.
  • A destination that you can reach: an email inbox, a webhook URL, Slack, Discord, Google Sheets, Microsoft Teams, PagerDuty, or Telegram.
  • Signed-in user access.

Procedure#

1. Sign in#

  1. Open Login.
  2. Sign in with your email address and password, or with OAuth (Google, Microsoft, Apple) if it is enabled.
  3. If the app asks for an email confirmation, open the Confirm email page and obey the instructions.

After you sign in, the top navigation shows Endpoints, Relay Targets, and Activity.

2. Create a relay target#

  1. Open Relay targets.
  2. Select Add target.
  3. Select the target type: Email, Webhook URL, Slack webhook, Discord webhook, Microsoft Teams, PagerDuty, Telegram, or Google Sheets.
  4. Enter the details for that type, then save.

These behaviors apply:

  • An Email target starts as Pending. You must confirm it.
  • A Webhook URL target record contains the destination URL only. Configure the authentication, the custom headers, the HMAC signing, the HTTPS enforcement, the retries, and the other delivery behavior on each endpoint destination that uses the target.
  • A provider-specific target such as Google Sheets, PagerDuty, Telegram, or Microsoft Teams has its own fields.

3. Complete email target confirmation#

  1. Open the confirmation email.
  2. Open the confirmation link.
  3. Select Confirm relay target.
  4. Make sure that the platform email target shows Confirmed and Available in the target list.

4. Create an endpoint#

  1. Open Endpoints and select Create endpoint.
  2. In Details, set the endpoint name, the accepted method, and the payload format. A new webhook endpoint starts with POST and JSON. Change these values if the sender uses a different format.
  3. In Security, configure the inbound authentication, the captcha, the required headers, and the CORS origins as necessary.
  4. In Outputs, attach the relay targets and configure the endpoint-specific values such as the webhook retries.
  5. Save the endpoint.

5. Send traffic to the endpoint URL#

  1. Open the endpoint edit page or the endpoint details page.
  2. Copy the endpoint URL (/relay/{endpointId}).
  3. Send a request that matches the configured method and payload format.

From Relay targets, you can use Test reachability for a Webhook URL. This action sends an unauthenticated request directly to that URL. It does not use the endpoint authentication, the headers, the signing, the HTTPS enforcement, the retries, or the failover. To examine the complete delivery configuration, send traffic through the saved endpoint.

6. Read the result in Activity#

  1. Open Request activity.
  2. Filter by your endpoint.
  3. Read the Request Log outcomes and error reasons.

Common final outcomes and failure outcomes:

  • Completed (ACCEPTED)
  • Method Not Allowed (METHOD_NOT_ALLOWED)
  • Auth Failed (AUTH_FAILED)
  • Missing Headers (MISSING_REQUIRED_HEADERS)
  • Validation Failed (FIELD_VALIDATION_FAILED)
  • Payload Too Large (PAYLOAD_TOO_LARGE)
  • Delivery Failed (DELIVERY_FAILED)

Expected result#

The setup is ready when these conditions are true:

  • At least one relay target is Available. A platform email target is Confirmed, and a custom SMTP email target is Verified.
  • The endpoint is enabled and has one destination or more.
  • The requests appear in Activity with the expected outcomes.

Common issues and fixes#

  • The email target stays pending: send a new confirmation and open the most recent link.
  • No traffic is visible: make sure that the sender uses the current endpoint URL.
  • Rejections in Activity: make the sender method, content type, authentication, and headers agree with the endpoint configuration.
  • Delivery failures: make sure that the target authentication, the URL, and the destination are correct.
← Back to documentation