WebhookBase documentation
Short guides for capturing webhook deliveries, inspecting payloads, replaying events, and forwarding traffic to localhost with the local agent.
Quick start
Create a project, add an endpoint, point a webhook provider at the ingest URL, and inspect the captured delivery.
Projects and endpoints
Use projects to group integrations or environments. Each endpoint gives you a public ingest URL for receiving webhook and callback deliveries.
Delivery inspection
A delivery is the inbound webhook WebhookBase received. Inspect headers, query parameters, body, metadata, and forwarding or replay attempts.
Replay and forwarding
Replay sends a captured delivery again. Forwarding sends a delivery to a configured destination or to localhost through a paired agent.
Agent setup
Download the local agent, run setup, confirm the pairing code, and use troubleshooting commands if service installation or forwarding fails.
Security and data handling
Review retention, subprocessors, AI Explain data use, vulnerability reporting, and other security practices.
First real setup
Create a project for the integration you are testing.
Create an endpoint and copy its public ingest URL.
Paste the URL into Stripe, GitHub, Slack, Shopify, or another webhook provider.
Trigger an event and inspect the saved delivery in WebhookBase.
Pair the agent when you want the delivery forwarded to localhost.
Core concepts
Workspace
The account boundary for members, billing, projects, endpoints, agents, usage, and retention.
Project
A group for one product, customer, integration, or environment such as staging and production.
Endpoint
A public webhook URL that receives requests and applies endpoint settings such as path rules and forwarding defaults.
Delivery
One inbound webhook request, including method, path, headers, query string, payload, status, and timestamps.
Attempt
One forwarding or replay result for a delivery, with response status, timing, and error details when available.
Agent
A local connector that lets WebhookBase forward captured traffic to localhost or private development services.
Main workflows
Capture
Point a provider to an endpoint URL. WebhookBase stores the request so you can inspect it later even if your app was offline.
Inspect
Review headers, query parameters, body, provider metadata, forwarding responses, and recent attempts from the delivery view.
Replay
Send a saved delivery again after your code changes. Treat replays as real requests because they can create real side effects.
Forward
Forward directly to a configured URL or through a paired agent when your destination is localhost or on a private network.
Explain
Use AI Explain for debugging help when a delivery or attempt fails. It is optional and only used when requested.
Control
Use endpoint settings for default responses, auto-forwarding, target URLs, assigned agents, path rules, and key rotation.
Replay and forwarding
Replay
Replays send saved deliveries again after your code changes. Use test modes, safe destinations, and idempotency controls because replayed requests can trigger real side effects.
Forwarding
Forward directly to a target URL or through a paired agent when your destination is localhost or a private development service.
Agent setup
Local development
The agent is intended for development and private test environments. Keep it paired only to workspaces and endpoints you trust.
Endpoint routing
Endpoint path rules let you allow or deny request paths before they are accepted. Rotating an endpoint key changes the ingest URL, so update webhook providers after rotation.
Before sending real traffic
Data handling
Webhook payloads, headers, and query strings are encrypted at rest. Retention depends on your plan and workspace settings.
Regulated data
Do not send HIPAA PHI, PCI card data, regulated production secrets, or highly regulated data unless we have separately agreed appropriate safeguards.
AI Explain
When used, AI Explain may send selected delivery metadata, headers, body excerpts, and attempt information to OpenAI.
Limits and retention
Plan limits may apply to projects, endpoints, deliveries, retention, replays, forwarding, AI features, agents, and team members. Current limits are shown in the app and legal terms.
Need help?
Include your workspace name, endpoint name, delivery ID if available, and the command or provider you were testing.