← Back to documentation

Getting Started

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

5 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, Apple, Microsoft) 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 navigation shows Endpoints, Relay targets, and Activity.

2. Create a relay target#

  1. Open Relay targets.
  2. Select Create relay target.
  3. In Target type, select one card: Email, Webhook URL, Slack webhook, Discord webhook, Microsoft Teams, PagerDuty, Telegram, or Google Sheets. At first, the form has no selected type.
  4. Enter the details for that type.
  5. Select Create relay target.

The Target type cards on the relay target form

These behaviors apply:

  • A platform Email target starts as Pending confirmation. You must confirm it. A custom SMTP email target starts as Pending verification until Verify connection succeeds.
  • 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.

The relay target list with one email target that waits for confirmation and three available relay targets

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 Available in the target list.

4. Create an endpoint#

  1. Open Endpoints and select Create endpoint.
  2. In Endpoint name above the tabs, enter the endpoint name.
  3. In Details, set the payload format. To change the accepted method, open the Advanced group in Details. A new webhook endpoint starts with POST and JSON. If the sender uses a different format, change these values.
  4. In Security, configure the inbound authentication, the captcha, the required headers, and the CORS origins as necessary.
  5. In Destinations, attach the relay targets and configure the endpoint-specific values such as the webhook retries.
  6. Select Create endpoint to save the endpoint.

After the save, the endpoint details page opens and shows the notification Endpoint created. The details page shows these items:

  • The endpoint URL.
  • A Next step card. It tells you to copy the URL, send a test request, and read the result in Activity.
  • For a webhook endpoint, the request snippets in the Send to this endpoint: code samples panel.

If you have no relay target yet, you can select Create relay target in the Destinations tab of the endpoint editor. The app opens the relay target form. After you save the relay target, the app returns you to the endpoint editor. For a custom SMTP email target, the edit page of the target opens first, so that you can select Verify connection. Then select Cancel to return to the endpoint editor. The editor does not keep the unsaved changes. If the editor has unsaved changes, the Unsaved changes dialog opens before the app leaves the editor. To keep the changes, save the endpoint first.

5. Send traffic to the endpoint URL#

  1. Open the endpoint details page or the endpoint edit page.
  2. Copy the endpoint URL (/relay/{endpointId}).
  3. Send a request that matches the configured method and payload format. For a webhook endpoint, you can copy a request snippet from the details page.

The endpoint details page with the endpoint URL, the Copy button, the code samples panel, and the endpoint activity chart

From Relay targets or from the relay target page, 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 Activity.
  2. In Endpoint, select your endpoint.
  3. Select the Request log tab.
  4. Read the outcomes and the error reasons.

The Request log view with the outcome filters and the request rows

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 becomes Available after you confirm it. A custom SMTP email target becomes Available after Verify connection succeeds.
  • 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.