Webhook Templates
Don't start from scratch. Templates provide pre-configured webhook setups for common scenarios.
Quick Start
Apply a template in 3 steps:
1. Choose a Template
Browse available templates in the Dashboard β Templates page. Each template has a unique ID. Copy the ID of the template you want to apply.
2. Configure Your Endpoint
Enter your endpoint URL. The template will automatically create an endpoint with the right configuration.
3. Start Receiving
Your endpoint is ready. Send events matching the template's event types and they'll be delivered automatically.
API Example
Apply a template via the API:
curl -X POST https://hooksniff-api-1046140057667.europe-west1.run.app/v1/templates/YOUR_TEMPLATE_ID/apply \
-H "Authorization: Bearer hr_live_YOUR_KEY" \
-H "Content-Type: application/json" \
-d {{"endpoint_url": "https://your-app.com/webhooks"}}Template Details
π E-commerce Template
Complete webhook setup for online stores. Includes order lifecycle, payment processing, shipping updates, and inventory events.
Event types: order.created, order.updated, order.cancelled, payment.completed, payment.failed, shipment.created, shipment.delivered, inventory.lowβοΈ SaaS Template
Subscription-based SaaS events. User lifecycle, subscription changes, billing events, and usage alerts.
Event types: user.created, user.deleted, subscription.created, subscription.renewed, subscription.cancelled, invoice.paid, invoice.overdue, usage.limit_reachedπ CI/CD Template
Continuous integration and deployment events. Build status, deployment notifications, test results, and rollback alerts.
Event types: build.started, build.completed, build.failed, deployment.started, deployment.completed, deployment.failed, test.passed, test.failedβοΈ Custom Template
Create your own template with custom event types, retry policy, and schema validation.
Available Templates
- β’ E-commerce β Order, payment, shipping, inventory events
- β’ SaaS β User, subscription, billing events
- β’ CI/CD β Build, deploy, test events
- β’ Custom β Create your own templates
Best Practices
- β’ Use descriptive event names β order.created is better than event1
- β’ Include all relevant data in the payload β avoid requiring follow-up API calls
- β’ Set appropriate retry policies β critical events need more retries
- β’ Use schema validation β catch payload errors before delivery
FAQ
Can I modify a template after applying it?
Yes. After applying a template, you can modify the endpoint, event types, and retry policy independently.
What happens if I apply a template to an existing endpoint?
The template will update the endpoint's configuration. Existing deliveries are not affected.
Can I share templates with my team?
Yes. Templates are organization-wide. All team members can see and apply templates.
Further Reading
- β’ Event Types β Define custom event types for your application
- β’ Schema Validation β Validate payloads before delivery
- β’ Retry Policy β Configure retry behavior per endpoint