Documentation
Reference guides for integrating, monitoring, and extending PayloadRelay.
Start Here
Set up access and send your first successful relay.
Delivery Setup
Configure relay targets and endpoints for production traffic.
Relay Targets
Create, secure, test, and maintain destination targets for webhook forwarding.
Endpoint Management
Configure endpoints, security, validation, destinations, and URL lifecycle.
Sending Data to an Endpoint
Code samples for sending HTTP requests to a PayloadRelay ingest endpoint in curl, Node.js, Python, Go, PHP, Ruby, C#, Java, and GitHub Actions.
HTTP Methods and Payload Formats
Match sender behavior with endpoint method and content-type rules.
Query Parameters
Accept data from URL query parameters instead of the request body.
Authentication and Secrets
Secure inbound and outbound deliveries with auth controls and secret hygiene.
HMAC Inbound Verification
Verify inbound webhook signatures to ensure requests originate from trusted sources.
HMAC Outbound Signing
Sign outbound webhooks so recipients can verify they came from PayloadRelay.
Rich Message Templates
Customize Slack, Discord, Microsoft Teams, and Telegram output messages with placeholder syntax and channel-native formatting.
Transformations and Payload Shaping
Modify, mask, and enrich payloads before delivery using transform rules and per-output formatting.
Retries and Delivery Behavior
Understand how delivery retries work per target type and how to design resilient downstream handling.
Webhook Retry Presets
Configure retry behavior for webhook outputs with presets tailored to different failure scenarios.
Environment Strategy
Organize staging and production workflows with clear endpoint/target separation.
Routing Filters
Forward specific requests to specific targets using routing filter rules.
Endpoint Rate Limits
Cap throughput per endpoint with per-minute request limits.
Maintenance Windows
Schedule automatic endpoint pauses for predictable downtime.
IP Allowlists
Restrict inbound traffic to specific IP addresses or CIDR ranges on webhook endpoints.
Troubleshooting Ingest
Common HTTP errors when sending data to a PayloadRelay relay endpoint and how to resolve them.
Email Ingestion
Receive inbound email as relay payloads without writing any 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
Diagnose common endpoint, target, and delivery failures.
Failure-Rate Alerts
Notify owners and optionally auto-pause endpoints when their failure rate crosses a threshold.
Incident Response
Coordinate response when webhook delivery health degrades.
Relay Targets
Route payloads to external destinations.
Microsoft Teams Webhooks
Connect a Microsoft Teams channel to PayloadRelay using an Incoming Webhook connector or Power Automate flow.
PagerDuty Integration
Route PayloadRelay webhook events to PagerDuty as incidents using the Events API v2.
Telegram Bot Integration
Send PayloadRelay webhook events to a Telegram chat or channel using a bot.
Slack Incoming Webhooks
Connect a Slack channel to PayloadRelay using an incoming webhook URL.
Custom SMTP Server (BYO-SMTP)
Send PayloadRelay email deliveries through your own SMTP server.
Workspace and Admin
Manage account, organization, billing, and support workflows.
Settings Guide
Manage profile, email, security, organization, and notification preferences.
Organization User Management
Invite teammates, assign roles, and manage invitation lifecycle.
Billing and Usage
Interpret plan tier, monthly usage, and reset windows from the Billing page.
Support
Submit support tickets with the details needed for faster resolution.
Audit Log
Review who did what and when across your PayloadRelay organization.
Examples
Step-by-step examples and real-world integration patterns.
Setting Up a Form with PayloadRelay as the Backend
Build HTML forms that submit directly to a PayloadRelay endpoint for serverless form handling.
Making API Calls to PayloadRelay
Send payloads to PayloadRelay endpoints using curl, JavaScript, and Python.
Sending GitHub Actions Emails and Reports
Notify your team about CI/CD outcomes by relaying GitHub Actions workflow data through PayloadRelay.
Setting Up a Slack Integration
Forward payloads to Slack channels using PayloadRelay's Slack webhook target type.
Setting Up a Discord Integration
Forward payloads to Discord channels using PayloadRelay's Discord webhook target type.
Multicasting a Webhook
Forward a single incoming payload to multiple destinations simultaneously using endpoint outputs.
Adding Authentication When Forwarding a Webhook
Secure both inbound and outbound legs of a webhook relay with 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 via PayloadRelay.
Shell Script: Pipe to Email via PayloadRelay
A command-line utility that pipes stdin or arguments to an email target through PayloadRelay.