Documentation
Reference guides for integrating, monitoring, and extending PayloadRelay.
Start Here
Configure access and send your first successful relay.
Delivery Setup
Configure relay targets and endpoints for production traffic.
Relay Targets
Create, use, and maintain destinations for endpoint deliveries.
Endpoint Management
Configure endpoints, security, validation, destinations, and URL changes.
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.
HTTP Methods and Payload Formats
Match a sender request to the method and the content-type that the endpoint accepts.
Query Parameters
Accept data from URL query parameters instead of the request body.
Authentication and Secrets
Secure inbound and outbound deliveries with authentication controls and secret handling.
HMAC Inbound Verification
Use HMAC signatures to protect inbound webhook endpoints.
HMAC Outbound Signing
Sign outbound webhooks so receivers can authenticate PayloadRelay deliveries.
Rich Message Templates
Customize Slack, Discord, Microsoft Teams, and Telegram messages with placeholders.
Transformations and Payload Shaping
Change, mask, and enrich a payload before delivery with transform rules and destination formatting.
Retries and Delivery Behavior
See how retries operate for each target type, and how a receiver handles a repeated delivery.
Webhook Retry Presets
Set the retry behavior of a webhook destination with a preset for each error condition.
Environment Strategy
Separate staging and production traffic with different endpoints and relay targets.
Routing Filters
Send selected requests to selected targets with routing filters.
Endpoint Rate Limits
Limit HTTP or inbound-email traffic on each endpoint.
Maintenance Windows
Schedule endpoint pauses for planned downtime.
IP Allowlists
Limit inbound traffic to selected IP addresses or CIDR ranges on webhook endpoints.
Troubleshooting Ingest
Find common HTTP errors when sending data to a PayloadRelay endpoint.
Email Ingestion
Receive inbound email as relay payloads without writing code.
Monitor and Troubleshoot
Track request outcomes and resolve delivery issues quickly.
Observability
Use charts and logs to monitor request acceptance and delivery outcomes.
Troubleshooting
Find common endpoint, target, and delivery problems.
Failure-Rate Alerts
Notify the relay targets when the failure rate of an endpoint meets a limit. You can also pause the endpoint.
Incident Response
Respond when webhook delivery health becomes worse.
Relay Targets
Route payloads to external destinations.
Microsoft Teams Webhooks
Connect a Microsoft Teams channel to PayloadRelay through a Power Automate workflow or legacy Incoming Webhook connector.
PagerDuty Integration
Send PayloadRelay webhook events to PagerDuty as incidents through Events API v2.
Telegram Bot Integration
Send PayloadRelay webhook events to a Telegram chat or channel with a bot.
Slack Incoming Webhooks
Connect a Slack channel to PayloadRelay with an incoming webhook URL.
Custom SMTP Server (BYO-SMTP)
Send PayloadRelay email deliveries through your SMTP server.
Account and Organization
Manage account, organization, billing, and support workflows.
Settings Guide
Manage profile, email, security, organization, and notification preferences.
Organization Member Management
Invite members, assign roles, and manage invitations.
Billing and Usage
Read plan limits, accepted-event usage, plan changes, payment recovery, invoices, and cancellation.
Support
Submit support tickets with the details needed for a useful response.
Audit Log
See which users and systems changed resources in your PayloadRelay organization.
Examples
Step-by-step examples and real-world integration patterns.
Configure a Form with PayloadRelay as the Backend
Build HTML forms that submit directly to a PayloadRelay endpoint without server-side code.
Making API Calls to PayloadRelay
Send data to PayloadRelay endpoints with curl, JavaScript, or Python.
Sending GitHub Actions Emails and Reports
Send GitHub Actions build, test, and deployment results through PayloadRelay.
Configure a Slack Integration
Send payloads to Slack channels with a Slack webhook target.
Configure a Discord Integration
Send payloads to Discord channels with a Discord webhook target.
Multicasting a Webhook
Send one incoming payload to several destinations on one endpoint.
Adding Authentication When Forwarding a Webhook
Protect the two sides of a webhook relay with inbound and outbound authentication.
Creating a Bookmarklet That Emails the Current URL
Build a browser bookmarklet that sends the current page URL and title to an email target.
Shell Script: Pipe to Email with PayloadRelay
Send terminal input to an email target through PayloadRelay.