> ## Documentation Index
> Fetch the complete documentation index at: https://dialnexa.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# List Webhooks
> List webhook endpoints for your workspace.
Read only
**Recommended.** This endpoint is part of the public `/v1` API reference and is the supported path for new integrations. See the [migration guide](/docs/api-reference/v1/migrating-to-v1) for versioning guidance.
Returns every webhook subscription registered on your workspace, paginated. Each entry includes the webhook's `id`, delivery `url`, subscribed `events`, active flag, creation timestamp, and a masked secret value. The original signing secret is never returned after creation. Use this endpoint to audit destinations, identify subscriptions to retire, or confirm configuration before a test.
## When to use this
* **Webhook audits**: render a table of every webhook with its destination, subscribed events, and active status.
* **Decommissioning checks**: find webhooks pointing at retired URLs before they accumulate failed deliveries.
* **Migration tooling**: enumerate webhooks before re-registering them under a new event taxonomy.
* **Operational dashboards**: combine with [Webhook retries and failures](/docs/api-access/webhook-retries-and-failures) to surface unhealthy subscriptions.
## Query parameters
| Parameter | Description |
| ----------- | ------------------------------------------- |
| `page` | Page number, starting from 1. |
| `limit` | Results per page (default 10). |
| `is_active` | Filter by active or inactive subscriptions. |
## Errors
* `403 Forbidden` is returned when the API key cannot read webhook configuration on this workspace.
## Related endpoints
* [Get Webhook Details](/docs/api-reference/v1/webhooks/get): fetch a single webhook's detail.
* [Create Webhook](/docs/api-reference/v1/webhooks/create): register a new subscription.
* [Update Webhook](/docs/api-reference/v1/webhooks/update): change URL, events, or active flag.
* [Delete Webhook](/docs/api-reference/v1/webhooks/delete): permanently remove a subscription.
* [Pagination](/docs/api-reference/pagination): how DialNexa list endpoints paginate.
## OpenAPI
````yaml GET /v1/user-webhooks
openapi: 3.0.0
info:
title: DialNexa API
description: >-
Public REST API for the DialNexa voice AI platform. Versioned endpoints are
under /v1; unversioned endpoints are legacy and deprecated.
version: 1.0.0
servers:
- url: https://api.dialnexa.com
description: DialNexa production API
security:
- bearer: []
tags:
- name: API Keys
- name: Agent Functions
- name: Agents V1
- name: Agents2
- name: Batch Calls
- name: Batch Calls V1
- name: Call Logs
- name: Calls
- name: Calls V1
- name: Campaign Leads
- name: Campaigns
- name: External Webhooks
- name: Knowledge Base
- name: Knowledge Base V1
- name: LLMs
- name: LLMs V1
- name: Languages
- name: Languages V1
- name: Organization Phone Numbers
- name: Organization Phone Numbers V1
- name: Phone Number Pricing
- name: Phone Number Pricing V1
- name: Transcribers
- name: Transcribers V1
- name: User Webhooks
- name: User Webhooks V1
- name: V1
- name: Voices
- name: Voices V1
- name: Webcall
- name: Workflow Leads
- name: Workflow Leads V1
- name: Workflows
- name: Workflows V1
paths:
/v1/user-webhooks:
get:
tags:
- User Webhooks
- User Webhooks V1
- V1
summary: List Webhooks
description: >-
Returns paginated webhook registrations. Secrets are masked in all list
responses.
operationId: UserWebhooksV1Controller_findAll
parameters:
- name: limit
required: false
in: query
description: 'Results per page (default: 10)'
schema:
example: 10
type: number
- name: page
required: false
in: query
description: 'Page number (default: 1)'
schema:
type: number
example: 1
responses:
'200':
description: Webhooks returned successfully.
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Webhooks fetched successfully
webhooks:
type: array
items:
type: object
properties:
id:
type: string
example: webhook_abc123
url:
type: string
example: https://webhook.site/your-endpoint
events:
type: array
items:
type: string
example:
- call.completed
is_active:
type: boolean
example: true
secret:
type: string
example: '********'
description: Always masked in list responses
createdAt:
type: string
format: date-time
page:
type: number
example: 1
limit:
example: 10
type: number
total:
type: number
example: 5
totalPages:
type: number
example: 1
examples:
success:
summary: Successful response
value:
total: 1
page: 1
limit: 10
webhooks:
- id: webhook_abc123
url: https://example.com/dialnexa/webhook
events:
- call.completed
is_active: true
createdAt: '2026-07-03T10:30:00.000Z'
'401':
description: Unauthorized - missing or invalid API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 401 Unauthorized
value:
statusCode: 401
message: API key is missing or invalid
error: Unauthorized
'403':
description: Forbidden - API key does not have access to this organization.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 403 Forbidden
value:
statusCode: 403
message: You do not have permission to access this resource
error: Forbidden
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 500 Internal Server Error
value:
statusCode: 500
message: Internal server error
error: Internal Server Error
security:
- bearer: []
components:
schemas:
ErrorResponse:
type: object
properties:
statusCode:
type: integer
example: 400
message:
oneOf:
- type: string
- type: array
items:
type: string
example: phone_number must be a valid E.164 phone number
error:
type: string
example: Bad Request
required:
- statusCode
- message
- error
securitySchemes:
bearer:
scheme: bearer
bearerFormat: JWT
type: http
````