Skip to main content

Documentation Index

Fetch the complete documentation index at: https://hypha-docs.plinqx.app/llms.txt

Use this file to discover all available pages before exploring further.

The Webhooks API lets you create, read, update, and delete webhook configurations programmatically.

​
Base URL

https://hypha-api.plinqx.app/services/webhooks

​
Authentication

All endpoints require authentication. See Authentication for details.

​
List Webhooks

List all webhooks in your tenant.

​
Endpoint

GET /services/webhooks

​
Response

​
data
array
required
Array of webhook objects

​
Get Webhook

Get a specific webhook by ID.

​
Endpoint

GET /services/webhooks/:id

​
Path Parameters

​
id
string
required
Webhook ID

​
Create Webhook

Create a new webhook.

​
Endpoint

POST /services/webhooks

​
Request Body

​
name
string
required
Webhook name
​
url
string
required
Webhook endpoint URL
​
events
array
required
Array of event types to subscribe to
​
secret
string
Optional secret for signature verification
​
headers
object
Optional custom headers to include
​
timeoutMs
integer
Request timeout in milliseconds (default: 30000)

​
Request Example

curl -X POST 'https://hypha-api.plinqx.app/services/webhooks' \
  -H 'Authorization: Bearer YOUR_SESSION_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "My Webhook",
    "url": "https://example.com/webhook",
    "events": ["invocation.completed", "approval.requested"],
    "secret": "your-webhook-secret"
  }'

​
Update Webhook

Update an existing webhook.

​
Endpoint

PATCH /services/webhooks/:id

​
Request Body

​
name
string
Updated name
​
url
string
Updated URL
​
events
array
Updated event subscriptions
​
enabled
boolean
Whether webhook is enabled

​
Delete Webhook

Delete a webhook.

​
Endpoint

DELETE /services/webhooks/:id

​
Webhook Statistics

Get webhook delivery statistics.

​
Endpoint

GET /services/webhooks/stats

​
Response

​
totalDeliveries
integer
required
Total delivery attempts
​
successfulDeliveries
integer
required
Successful deliveries
​
failedDeliveries
integer
required
Failed deliveries
​
successRate
number
required
Success rate (0-1)

​
Failed Deliveries

Get failed webhook deliveries.

​
Endpoint

GET /services/webhooks/deliveries/failed

​
Query Parameters

​
limit
integer
Maximum results (default: 50)
​
offset
integer
Pagination offset

​
Retry Failed Deliveries

Retry all failed deliveries for a webhook.

​
Endpoint

POST /services/webhooks/:id/deliveries/retry-all-failed

​
Error Responses

Standard error format: 
{
  "error": {
    "message": "Error description",
    "code": "ERROR_CODE"
  }
}

​
Next Steps

Collections API

Manage Collections via API

Vault API

Manage credentials via API