API Reference
Complete reference for the Web-Hookify REST API. All endpoints, parameters, and response formats.
Base URL
All API requests should be made to this base URL with the appropriate endpoint path.
Authentication
Web-Hookify uses API key authentication. Include your API key in the Authorization header.
Authorization Header
Authorization: Bearer wh_live_1234567890abcdef
API Key Types
- •
wh_test_- Test environment keys - •
wh_live_- Production environment keys
Webhooks
Manage your webhook endpoints with these API endpoints.
/webhooksCreate a new webhook endpoint
Request Body
{
"service": "stripe",
"description": "Payment notifications",
"events": ["payment.succeeded", "payment.failed"],
"metadata": {
"environment": "production",
"team": "payments"
}
}Response
{
"id": "wh_1234567890",
"url": "https://api.webhookify.dev/v1/hooks/stripe-abc123",
"service": "stripe",
"description": "Payment notifications",
"events": ["payment.succeeded", "payment.failed"],
"metadata": {
"environment": "production",
"team": "payments"
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z",
"status": "active"
}/webhooksList all webhook endpoints
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Number of results to return (1-100) |
| offset | integer | Number of results to skip |
| service | string | Filter by service name |
/webhooks/{id}Retrieve a specific webhook endpoint
/webhooks/{id}Update a webhook endpoint
/webhooks/{id}Delete a webhook endpoint
Events
Retrieve and manage webhook events and delivery logs.
/eventsList webhook events and delivery attempts
Response
{
"data": [
{
"id": "evt_1234567890",
"webhook_id": "wh_1234567890",
"type": "payment.succeeded",
"data": {
"id": "pi_1234567890",
"amount": 2000,
"currency": "usd",
"status": "succeeded"
},
"created_at": "2024-01-15T10:30:00Z",
"delivered_at": "2024-01-15T10:30:01Z",
"status": "delivered",
"attempts": 1
}
],
"has_more": false,
"total_count": 1
}Rate Limits
Understanding API rate limits and best practices for handling them.
Rate Limit Tiers
Rate Limit Headers
X-RateLimit-Limit: 1000 X-RateLimit-Remaining: 999 X-RateLimit-Reset: 1642262400
Rate Limit Exceeded
When you exceed the rate limit, you'll receive a 429 Too Many Requests response. Implement exponential backoff in your retry logic.
Error Handling
Understanding error responses and how to handle them properly.
HTTP Status Codes
| Code | Description |
|---|---|
| 200 | OK - Request successful |
| 201 | Created - Resource created successfully |
| 400 | Bad Request - Invalid request parameters |
| 401 | Unauthorized - Invalid or missing API key |
| 404 | Not Found - Resource not found |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error - Server error |