Endpoints API
Manage your webhook endpoints programmatically. Create, update, delete, and list endpoints.
Base URL
https://api.hookwatch.dev/v1/endpointsThe Endpoint Object
Json
Properties
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the endpoint |
slug | string | URL slug used in the webhook URL (/wh/:slug) |
name | string | Human-readable name for the endpoint |
destination_url | string | URL where webhooks are forwarded |
retry_config | object | Retry configuration (max_retries and intervals in seconds) |
is_active | boolean | Whether the endpoint is accepting webhooks |
created_at | string | ISO 8601 timestamp of creation |
updated_at | string | ISO 8601 timestamp of last update |
Create Endpoint
Create a new webhook endpoint.
POST /v1/endpointsRequest Body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name for the endpoint |
destination_url | string | Yes | URL to forward webhooks to |
Example
curl
List Endpoints
Retrieve all endpoints for the authenticated user.
GET /v1/endpointsResponse
Json
Get Endpoint
Retrieve a specific endpoint by ID.
GET /v1/endpoints/:idPath Parameters
| Field | Type | Description |
|---|---|---|
id | string | The endpoint ID (e.g., ep_abc123) |
Update Endpoint
Update an existing endpoint's configuration.
PUT /v1/endpoints/:idAll fields are optional. Only include fields you want to update.
Request Body
| Field | Type | Description |
|---|---|---|
name | string | New name for the endpoint |
destination_url | string | New destination URL |
is_active | boolean | Enable or disable the endpoint |
retry_config | object | Custom retry configuration (Pro/Business plans) |
Example
curl
Delete Endpoint
Permanently delete an endpoint and all associated events.
DELETE /v1/endpoints/:idWarning
This action is irreversible. All events for this endpoint will be permanently deleted.
Error Codes
| Status | Error | Description |
|---|---|---|
400 | Bad Request | Invalid request body or parameters |
401 | Unauthorized | Invalid or missing access token |
403 | Forbidden | Endpoint limit reached (upgrade plan) |
404 | Not Found | Endpoint not found |