Gen-Endpoint
Back to API List
Webhook Management API
Register, manage, test webhook endpoints, and track delivery attempts with retry logic.
Integration
Internal API - Hosted by this App
API Endpoints & Usage
Explore and interact with the available endpoints for the Webhook Management API. These API routes are live! The paths shown below are relative to your application's base URL. For example, if this application is hosted at https://gen-endpoint.com, an endpoint path for this API, such as /api/webhooks, would be accessible at https://gen-endpoint.com/api/webhooks. You can use the "Try it out" section for each endpoint or use tools like curl, Postman, or your browser's address bar (for GET requests) to interact with them.
POST

/api/webhooks

Register new webhook endpoint with event subscriptions.

Show Static Examples

Example Request Body:

{
  "url": "https://api.example.com/webhooks/orders",
  "events": ["order.created", "order.updated", "payment.completed"],
  "secret": "whsec_1234567890",
  "description": "Order processing webhook"
}

Example Response:

{
  "id": "wh_789",
  "url": "https://api.example.com/webhooks/orders",
  "events": [
    "order.created",
    "order.updated",
    "payment.completed"
  ],
  "status": "active",
  "createdAt": "2024-08-16T12:00:00Z"
}
Try it out
POST

/api/webhooks/{webhookId}/test

Test webhook delivery with sample payload. Replace {webhookId} with an actual ID.

Show Static Examples

Example Request Body:

{
  "event": "order.created",
  "testPayload": {
    "orderId": "order_123",
    "amount": 99.99
  }
}

Example Response:

{
  "testId": "test_456",
  "status": "success",
  "responseCode": 200,
  "responseTime": 250,
  "deliveredAt": "2024-08-16T12:01:00Z"
}
Try it out

Replace placeholders (e.g., {userId}) with actual values in the path above.

GET

/api/webhooks/logs

Get webhook delivery logs with filtering and status.

Show Static Examples

Example Request Parameters:

?webhookId=wh_789&status=failed&limit=50

Example Response:

{
  "logs": [
    {
      "id": "log_123",
      "webhookId": "wh_789",
      "event": "order.created",
      "status": "failed",
      "responseCode": 500,
      "attempts": 3,
      "nextRetry": "2024-08-16T12:15:00Z"
    }
  ]
}
Try it out

You can add or change query parameters in the path above (e.g., ?name=User).