← Back to documentation

Endpoint Management

Full guide for creating and maintaining endpoints that reliably accept and forward traffic.

14 min read

Endpoints are inbound relay URLs. They validate requests, then forward accepted traffic to configured outputs.

Purpose

Use this guide to:

  • Create/edit endpoints.
  • Configure method, payload format, retries, and security.
  • Configure field validation.
  • Attach outputs (destinations).
  • Rotate URLs and manage endpoint lifecycle.

Prerequisites and permissions

  • Signed-in account.
  • Relay targets already created.
  • Email targets must be Confirmed before they can be selected as outputs.

Step-by-step workflow

1. Create endpoint

  1. Open Endpoints and select Create endpoint.
  2. In Details, set:
  • Name (required, max 100)
  • Optional description (max 500)
  • Accepted HTTP method
  • Expected payload format (not used for GET/HEAD)
  • Delivery retries
  1. Save endpoint.

2. Configure details behavior

  • Any method accepts all methods, but GET/HEAD still have no body.
  • Payload format must match incoming Content-Type for body-capable methods.
  • Delivery retries are endpoint-level:
  • Default 0
  • Configurable up to your plan max
  • BASIC plan max is 0

3. Configure security

Security tab supports:

  • Inbound auth: None, Basic, Bearer token, API key header
  • Human verification: None, Cloudflare Turnstile, Google reCAPTCHA
  • Required request headers (exact-value matches)
  • CORS origins (one per line; blank means allow any)

Rules:

  • Captcha requires body-capable method and JSON/FORM payload format.
  • Leave secret fields blank during edit to keep stored values.

4. Configure field validation

Field validation is available when:

  • Method is not GET/HEAD
  • Payload format is not text/plain

Supported validation types:

  • STRING, INTEGER, FLOAT, BOOLEAN, EMAIL, REGEX

Notes:

  • JSON/form support dot-path fields (for example user.email).
  • XML supports XPath expressions.
  • Regex entries require a valid pattern.

5. Configure target destinations (outputs)

  1. In Target destinations, select one or more relay targets.
  2. Configure output-specific settings:
  • Email: subject, body format (RAW_PAYLOAD, TEXT, HTML), optional body template
  • Slack: markdown on/off
  • Discord: TTS on/off
  1. Save changes.

Important: endpoint routing is stored in the outputs array.

6. URL rotation and lifecycle actions

  • Regenerate URL creates a new endpoint URL immediately.
  • Old URL stops working right away.
  • Endpoint can be enabled/disabled.
  • Delete removes endpoint config and related activity rows.

Expected result and verification checks

  • Endpoint appears with expected method/format/security settings.
  • Accepted traffic logs as ACCEPTED in Activity.
  • Destination deliveries occur for selected outputs.

Common issues and fixes

  • "No relay targets": create targets first.
  • Email output unavailable: confirm the email target.
  • Validation failures: check field names/types/patterns.
  • Captcha errors: confirm token field name and provider secret.
  • Delivery failures: check target URL/auth/header/TLS config.

Related guides

← Back to documentation