webhook.party Documentation

Overview

webhook.party is a minimalist webhook testing service. Create password-protected channels, receive webhooks, inspect payloads, and view Markdown content all in one place.

Key Features:

• Password-protected channels (8-char IDs)
• Optional password requirement on webhook posts
• Markdown rendering support
• Auto-deletion after 100 days of inactivity
• Dashboard to manage multiple channels
• Full webhook payload capture (headers, body, IP, query params)

Getting Started

1. Create a Channel

Go to the homepage and create a channel with a secure password (min. 6 chars). You'll get:

• Channel ID: 8-character unique identifier
• Channel URL: /h/{id} to view and manage
• Webhook URL: /{id} to receive webhooks

2. Send Your First Webhook

curl -X POST http://localhost:3000/abc12345 \
  -H "Content-Type: application/json" \
  -d '{"message": "Hello webhook.party!"}'

3. View Webhooks

Open your channel at http://localhost:3000/h/abc12345, enter your password, and see incoming webhooks in real-time.

Channel Management

Password Protection on Webhooks

Optional: Require a separate password when posting webhooks to your channel.

Setup: When creating a channel, check "Protect webhooks with password" and set a separate webhook password. This is different from your channel password.

• Channel Password: Required to view/manage webhooks in your channel
• Webhook Password: Required only when POST-ing new webhooks (if protection is enabled)

Why two passwords? Your CI/CD system can post webhooks without needing the admin channel password.

Send webhook with password:

# Query parameter
curl -X POST http://localhost:3000/abc12345?password=webhook-secret \
  -H "Content-Type: application/json" \
  -d '{"data": "value"}'

# Header
curl -X POST http://localhost:3000/abc12345 \
  -H "X-Webhook-Password: webhook-secret" \
  -H "Content-Type: application/json" \
  -d '{"data": "value"}'

Auto-Deletion

Channels are automatically deleted 100 days after the last webhook is received. You can manually delete a channel anytime from its page or dashboard.

Dashboard

Visit /dashboard.html to manage all your channels:

• View all channels and their IDs
• Add custom labels/names
• Toggle password protection ([LOCKED] = enabled)
• Quick access links

Webhook Content Types

JSON Webhooks (Default)

Send structured JSON data:

curl -X POST http://localhost:3000/abc12345 \
  -H "Content-Type: application/json" \
  -d '{
    "status": "success",
    "user_id": 123,
    "timestamp": "2024-08-12T19:30:00Z"
  }'

Displayed as formatted JSON in the channel view.

Markdown Webhooks

Send and render Markdown content:

curl -X POST http://localhost:3000/abc12345?markdown=true \
  -H "Content-Type: text/markdown" \
  -d "# Deployment Successful

- Service: api-v2
- Version: 1.2.3
- Status: OK"

Or use Content-Type: text/markdown header for auto-detection.

Rendered as formatted HTML in the channel view with support for:

• Headings (h1-h3)
• Bold, italic, code
• Lists and blockquotes
• Code blocks with syntax highlighting
• Links

Use Cases

GitHub/GitLab Webhooks

Test webhook payloads from version control systems:

GitHub Settings → Webhooks → Add webhook
Payload URL: https://webhook.party/webhook/your-channel-id
Content type: application/json

Monitoring & Alerts

Send Markdown alerts from monitoring systems:

#!/bin/bash
curl -X POST https://webhook.party/alerts \
  -H "Content-Type: text/markdown" \
  -d "# ALERT: CPU High

Server: prod-01
CPU: 95%
Action: Scaling up instances"

CI/CD Integration

Capture deployment logs and notifications:

# In your CI/CD pipeline
curl -X POST https://webhook.party/deployments?password=$WEBHOOK_PASSWORD \
  -H "Content-Type: application/json" \
  -d '{
    "pipeline": "'$CI_PIPELINE_ID'",
    "status": "success",
    "branch": "'$CI_COMMIT_BRANCH'",
    "duration": "'$CI_JOB_DURATION's"
  }'

Testing Integrations

Quickly test how your application handles incoming webhooks without complex setup.

API Reference

All Endpoints Summary

• POST /api/channel/create — Create a new channel
• POST /api/channel/{id}/verify — Verify channel password
• GET /api/channel/{id}/webhooks — Get all webhooks
• POST /api/channel/{id}/delete — Delete channel
• POST /{id} — Send webhook

Status Codes

• 200 — Request successful
• 202 — Webhook accepted (async processing)
• 400 — Bad request (validation error)
• 403 — Forbidden (wrong password)
• 404 — Not found (channel doesn't exist)
• 500 — Server error

Best Practices

Security

• Use strong passwords (min. 6 chars, consider 12+)
• Enable webhook password protection for sensitive channels
• Don't share channel IDs or passwords via insecure channels
• Use HTTPS in production

Webhook Design

• Include timestamps in your webhook payloads
• Use descriptive field names
• For alerts, use Markdown for better readability
• Keep payloads under 10MB

Channel Management

• Use the Dashboard to organize multiple channels
• Add descriptive labels to channels in the Dashboard
• Use separate channels for different purposes (staging/prod)
• Export webhooks regularly for backup

Limitations & Notes

• Storage: All webhooks are stored indefinitely until channel deletion
• Auto-cleanup: Channels auto-delete after 100 days without webhooks
• Payload size: Maximum 10MB per webhook
• Retention: Manual deletion removes all webhooks permanently
• Persistence: Data persists between server restarts (JSON-based storage)

Troubleshooting

403 Password Required Error

If your channel has password protection enabled on webhooks:

• Add query parameter: ?password=your-password
• Or set header: X-Webhook-Password: your-password

404 Channel Not Found

Double-check your channel ID. It must be exactly 8 characters.

Markdown Not Rendering

Ensure you're using ?markdown=true or Content-Type: text/markdown.

Channel Deleted Unexpectedly

Channels auto-delete after 100 days without incoming webhooks. Send a webhook to reset the timer.