← Back to documentation

Getting Started

End-to-end quickstart from login to first verified delivery in Activity.

8 min read

Use this guide to go from first login to a working endpoint with visible activity.

Purpose

This workflow helps you:

  • Sign in with session-cookie auth.
  • Create a relay target (destination).
  • Create an endpoint (ingress URL).
  • Send a test request and verify outcomes.

Prerequisites and permissions

  • Access to /login (or /signup when enabled).
  • A reachable destination: email inbox, webhook URL, Slack incoming webhook, or Discord webhook.
  • Signed-in user access.

Step-by-step workflow

1. Sign in

  1. Open Login.
  2. Sign in with email/password or OAuth (Google, Microsoft, Apple) when enabled.
  3. If prompted, confirm your email from the Confirm email page.

UI cue: after successful login, the top navigation with Endpoints, Targets, and Activity becomes available.

2. Create a relay target

  1. Open Relay targets.
  2. Select Add target.
  3. Choose target type: Email, Webhook URL, Slack webhook, or Discord webhook.
  4. Enter target value, then save.

Behavior to know:

  • Email targets start as Pending and must be confirmed.
  • Webhook URL targets support auth, custom headers, and SSL enforcement.

3. Confirm email targets (email targets only)

  1. Open the confirmation email.
  2. Follow the link to /targets/confirm?token=....
  3. The page validates the token (GET /relay-targets/confirm).
  4. Select Confirm relay target to consume the token (POST /relay-targets/confirm/consume).
  5. Verify target status changes to Confirmed.

4. Create an endpoint

  1. Open Endpoints and select Create endpoint.
  2. In Details, set endpoint name, accepted method, payload format, and delivery retries.
  3. In Security, configure inbound auth, captcha, required headers, and CORS origins as needed.
  4. In Target destinations, select relay targets and configure per-output options.
  5. Save the endpoint.

Important: endpoints use an outputs model. You attach destinations directly in Target destinations.

5. Send traffic to the endpoint URL

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

Optional: from Relay targets, use Send test to validate destination wiring.

6. Verify in Activity

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

Common success/failure outcomes:

  • ACCEPTED
  • METHOD_NOT_ALLOWED
  • AUTH_FAILED
  • MISSING_REQUIRED_HEADERS
  • FIELD_VALIDATION_FAILED
  • DELIVERY_FAILED

Expected result and verification checks

You are done when:

  • At least one relay target is usable (Confirmed for email targets).
  • Endpoint is enabled and has one or more outputs.
  • Requests appear in Activity with expected outcomes.

Common issues and fixes

  • Email target stays pending: resend confirmation and open the latest link.
  • No traffic visible: verify sender uses the current endpoint URL.
  • Rejections in Activity: align sender method/content type/auth/headers with endpoint config.
  • Delivery failures: validate target auth, URL, and destination availability.

Related guides

← Back to documentation