← Back to documentation

Relay Targets

Complete lifecycle guide for email, webhook, Slack, and Discord relay targets.

12 min read

Relay targets are delivery destinations used by endpoint outputs.

Purpose

Use this guide to:

  • Create and edit targets.
  • Configure webhook auth and custom headers.
  • Confirm email targets.
  • Send tests.
  • Remove unused targets.

Prerequisites and permissions

  • Signed-in account.
  • Valid destination details (email or webhook URL).

Step-by-step workflow

1. Create a target

  1. Open Relay targets.
  2. Select Add target.
  3. Choose type:
  • Email
  • Webhook URL
  • Slack webhook
  • Discord webhook
  1. Enter target value and optional name/description.
  2. Save.

2. Configure webhook targets (Webhook URL type)

Available options:

  • Require valid SSL certificate
  • Auth type: None, Basic, Bearer, API key
  • Custom headers (up to 25)

Validation rules:

  • URL must be http or https and not localhost/private-network ranges.
  • API key/custom header names must use letters, numbers, and hyphens.
  • Custom headers cannot conflict with auth headers.

3. Confirm email targets

Email targets start as Pending.

  1. Open confirmation link.
  2. Confirmation page previews token validity (GET /relay-targets/confirm).
  3. Select Confirm relay target to consume token (POST /relay-targets/confirm/consume).
  4. Verify status becomes Confirmed.

Resend confirmation is available for pending email targets.

4. Edit or delete targets

  • Type cannot be changed after creation.
  • Secrets can be left blank on edit to keep current stored values.
  • Delete fails if the target is still used by an endpoint output.

5. Send test deliveries

Use Send test in the targets list.

Behavior by type:

  • Email: requires confirmed status.
  • Slack/Discord: queues test message.
  • Webhook: choose method + payload format + include body.

Webhook test rules:

  • Method must be explicit (not ANY).
  • GET/HEAD tests never include body.
  • Test outcomes appear in Activity as TEST_ACCEPTED, TEST_REJECTED, or TEST_RATE_LIMITED.
  • Test API is rate limited to 5 requests per minute per account.

Expected result and verification checks

  • Target appears with expected type and status.
  • Confirmed email targets are selectable in endpoint outputs.
  • Test deliveries are queued and reflected in Activity.

Common issues and fixes

  • Invalid target URL: check protocol/host format and avoid private hosts.
  • Email target blocked from outputs: confirm target first.
  • Test rate-limited: wait for Retry-After window.
  • Webhook test rejected: verify auth type, required credentials, and payload settings.

Related guides

← Back to documentation