Documentation

Reference guides for integrating, monitoring, and extending PayloadRelay.

Delivery Setup

Configure relay targets and endpoints for production traffic.

Relay Targets

Create, use, and maintain destinations for endpoint deliveries.

12 min read

Endpoint Management

Configure endpoints, security, validation, destinations, and URL changes.

26 min read

Sending Data to an Endpoint

Send HTTP requests to a PayloadRelay endpoint with curl, Node.js, Python, Go, PHP, Ruby, C#, Java, or GitHub Actions.

4 min read

HTTP Methods and Payload Formats

Match a sender request to the method and the content-type that the endpoint accepts.

3 min read

Query Parameters

Accept data from URL query parameters instead of the request body.

6 min read

Authentication and Secrets

Secure inbound and outbound deliveries with authentication controls and secret handling.

3 min read

HMAC Inbound Verification

Use HMAC signatures to protect inbound webhook endpoints.

5 min read

HMAC Outbound Signing

Sign outbound webhooks so receivers can authenticate PayloadRelay deliveries.

6 min read

Rich Message Templates

Customize Slack, Discord, Microsoft Teams, and Telegram messages with placeholders.

4 min read

Transformations and Payload Shaping

Change, mask, and enrich a payload before delivery with transform rules and destination formatting.

15 min read

Retries and Delivery Behavior

See how retries operate for each target type, and how a receiver handles a repeated delivery.

10 min read

Webhook Retry Presets

Set the retry behavior of a webhook destination with a preset for each error condition.

8 min read

Environment Strategy

Separate staging and production traffic with different endpoints and relay targets.

2 min read

Routing Filters

Send selected requests to selected targets with routing filters.

7 min read

Endpoint Rate Limits

Limit HTTP or inbound-email traffic on each endpoint.

5 min read

Maintenance Windows

Schedule endpoint pauses for planned downtime.

6 min read

IP Allowlists

Limit inbound traffic to selected IP addresses or CIDR ranges on webhook endpoints.

4 min read

Troubleshooting Ingest

Find common HTTP errors when sending data to a PayloadRelay endpoint.

5 min read

Email Ingestion

Receive inbound email as relay payloads without writing code.

20 min read