Hookmetry REST API reference
The API uses a bearer JWT. API operations are scoped to the authenticated user account.
Authentication
http
Authorization: Bearer <JWT>Endpoints
| Method and path | Purpose |
|---|---|
| POST /api/endpoints | Create an endpoint. Returns 201 on success. |
| GET /api/endpoints | List your endpoints. |
| GET /api/endpoints/:endpointId | Read endpoint details. |
| PATCH /api/endpoints/:endpointId | Update name, description, or active state. |
| DELETE /api/endpoints/:endpointId | Delete an endpoint. |
| POST /api/endpoints/:endpointId/regenerate-secret | Regenerate a Generic HMAC-SHA256 secret. |
Webhook logs, replay, and sharing
| Method and path | Purpose |
|---|---|
| GET /api/webhooks/logs | List logs. Supports limit, offset, status, and search. |
| GET /api/webhooks/logs/:logId | Read one webhook log. |
| POST /api/webhooks/logs/:logId/analyze | Request or retrieve AI remediation for an eligible failure. |
| POST /api/replay/:webhookLogId | Replay a log. Request body requires targetUrl. |
| GET /api/replay/:webhookLogId/history | Read replay history. |
| POST /api/webhooks/:logId/share | Create a share link. expiresInHours defaults to 24. |
| DELETE /api/webhooks/:logId/share | Revoke a share link. |
| GET /api/observability/metrics | Read account-scoped traffic and validation metrics. |
| GET /api/cli/diagnose/:logId | Read reconstruction and destination diagnostics for CLI use. |
| GET /api/cli/explain/:logId | Request or retrieve CLI AI remediation. |
Replay example
bash
curl --request POST 'https://<Hookmetry host>/api/replay/<webhookLogId>' --header 'authorization: Bearer <JWT>' --header 'content-type: application/json' --data '{"targetUrl":"https://staging.example.com/webhooks/provider"}'