Endpoint management API

All routes require Authorization: Bearer <jwt> unless noted.

Base path: https://api.hooknexus.com/api/endpoints

---

Create endpoint

POST /api/endpoints

Creates a new webhook endpoint and returns its public URL.

Body parameters (JSON)

Parameter	Type	Required	Description
permanent	boolean	No	If true, creates a permanent endpoint (subject to plan limits). Default: false (TTL-based).
alias	string	No	Optional human-readable alias when your plan supports custom aliases.

Example request

POST /api/endpoints HTTP/1.1
Host: api.hooknexus.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: application/json

{
  "permanent": false
}

Example response (201 Created)

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "url": "https://api.hooknexus.com/h/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "expiresAt": "2026-03-24T12:00:00.000Z",
  "isPermanent": false,
  "createdAt": "2026-03-23T12:00:00.000Z"
}

Note

If endpoint or permanent-endpoint quotas are exceeded, the API returns 403 with code: "LIMIT_EXCEEDED" or FEATURE_REQUIRED.

---

List endpoints

GET /api/endpoints

Returns all non-expired endpoints for the current user, plus usage summary.

Example response (200 OK)

{
  "endpoints": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "user_id": "user-uuid",
      "alias": null,
      "is_permanent": 0,
      "expires_at": "2026-03-24T12:00:00.000Z",
      "request_count": 42,
      "last_request_at": "2026-03-23T11:00:00.000Z",
      "created_at": "2026-03-23T10:00:00.000Z",
      "updated_at": "2026-03-23T11:00:00.000Z"
    }
  ],
  "usage": {
    "dailyRequests": 120,
    "dailyRequestsMax": 5000
  }
}

---

Get endpoint detail

GET /api/endpoints/:id

Path parameters

Parameter	Description
id	Endpoint UUID

Example response (200 OK)

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "user_id": "user-uuid",
  "alias": null,
  "is_permanent": 0,
  "expires_at": "2026-03-24T12:00:00.000Z",
  "request_count": 42,
  "last_request_at": "2026-03-23T11:00:00.000Z",
  "created_at": "2026-03-23T10:00:00.000Z",
  "updated_at": "2026-03-23T11:00:00.000Z"
}

---

Delete endpoint

DELETE /api/endpoints/:id

Deletes the endpoint and its associated webhook logs.

Example response (200 OK)

{
  "success": true
}

---

Request history

GET /api/endpoints/:id/requests

Returns paginated webhook log entries for an endpoint.

Query parameters

Parameter	Type	Default	Description
limit	integer	50	Max rows per page
offset	integer	0	Pagination offset

Note

To narrow by HTTP method (e.g. only POST), filter the returned requests array in your client—there is no separate method query parameter on this route.

Example request

GET /api/endpoints/a1b2c3d4-e5f6-7890-abcd-ef1234567890/requests?limit=20&offset=0 HTTP/1.1
Host: api.hooknexus.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Example response (200 OK)

{
  "requests": [
    {
      "id": "log-uuid-1",
      "endpoint_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "method": "POST",
      "path": "/h/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "headers": { "content-type": "application/json" },
      "query": {},
      "body": "{\"hello\":\"world\"}",
      "content_type": "application/json",
      "ip": "203.0.113.10",
      "user_agent": "curl/8.0",
      "size": 18,
      "created_at": "2026-03-23T12:00:00.000Z"
    }
  ],
  "total": 1,
  "limit": 20,
  "offset": 0
}