Skip to main content
GET
/
v1
/
webhooks
curl "https://api.ringyo.ai/v1/webhooks?status=active" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "data": [
    {
      "id": "wh_abc123",
      "url": "https://your-app.com/webhooks/ringyo",
      "events": ["call.completed", "call.recording.ready"],
      "description": "Production webhook",
      "status": "active",
      "last_triggered_at": "2024-01-15T14:22:00Z",
      "created_at": "2024-01-10T08:00:00Z"
    },
    {
      "id": "wh_def456",
      "url": "https://staging.your-app.com/webhooks/ringyo",
      "events": ["*"],
      "description": "Staging - all events",
      "status": "active",
      "last_triggered_at": "2024-01-15T12:00:00Z",
      "created_at": "2024-01-12T10:30:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "total": 2
}

​
Request

Retrieve a list of all webhook endpoints configured for your account.

​
Headers

​
Authorization
string
required
Bearer token for authentication. Format: Bearer YOUR_API_KEY

​
Query Parameters

​
limit
integer
default:"20"
Number of webhooks to return (1-100)
​
cursor
string
Pagination cursor from a previous response
​
status
string
Filter by status: active, inactive, failing

​
Response

​
data
array
Array of webhook objects
​
has_more
boolean
Whether there are more results available
​
next_cursor
string
Cursor for fetching the next page
​
total
integer
Total number of webhooks
curl "https://api.ringyo.ai/v1/webhooks?status=active" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "data": [
    {
      "id": "wh_abc123",
      "url": "https://your-app.com/webhooks/ringyo",
      "events": ["call.completed", "call.recording.ready"],
      "description": "Production webhook",
      "status": "active",
      "last_triggered_at": "2024-01-15T14:22:00Z",
      "created_at": "2024-01-10T08:00:00Z"
    },
    {
      "id": "wh_def456",
      "url": "https://staging.your-app.com/webhooks/ringyo",
      "events": ["*"],
      "description": "Staging - all events",
      "status": "active",
      "last_triggered_at": "2024-01-15T12:00:00Z",
      "created_at": "2024-01-12T10:30:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "total": 2
}

​
Webhook Object

FieldTypeDescription
idstringUnique identifier
urlstringWebhook endpoint URL
eventsarraySubscribed event types
descriptionstringDescription of the webhook
statusstringactive, inactive, or failing
last_triggered_atstringLast time webhook was triggered
failure_countintegerConsecutive failures (when failing)
created_atstringISO 8601 timestamp

​
Webhook Status

StatusDescription
activeWebhook is receiving events normally
inactiveWebhook is disabled
failingWebhook has consecutive delivery failures
Webhooks automatically enter failing status after 5 consecutive delivery failures. They will be automatically disabled after 100 consecutive failures.

​
Error Codes

CodeDescription
invalid_cursorThe pagination cursor is invalid
invalid_statusStatus must be ‘active’, ‘inactive’, or ‘failing’