> ## 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.
# Get Webhook Details
> Fetch one webhook by ID.
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 the full record for a single webhook subscription: the delivery URL, the list of subscribed events, the active/inactive flag, and the creation timestamp. The signing `secret` is only returned in the response of [Create Webhook](/docs/api-reference/v1/webhooks/create); afterwards it is never echoed back. If you have lost the secret, delete the webhook and recreate it.
## When to use this
Use this endpoint when you need to inspect a webhook subscription before changing or removing it. Common cases:
* **Pre-deploy verification**: confirm the subscribed events on a webhook match what your downstream consumer expects before publishing a release.
* **Audit and compliance reviews**: render the destination URL and event list for an internal review.
* **Debugging delivery failures**: confirm the webhook is still `is_active: true` before chasing receiver-side issues. Cross-reference with [Webhook retries and failures](/docs/api-access/webhook-retries-and-failures).
For the entire set of webhooks on the workspace, use [List Webhooks](/docs/api-reference/v1/webhooks/list).
## Path parameters
| Parameter | Description |
| --------- | ----------------------------------------------- |
| `id` | The webhook ID, for example `whk_c9v3nz8rq4pm`. |
## Errors
* `404 Not Found` is returned when the webhook does not exist.
* `403 Forbidden` is returned when the API key cannot read webhook configuration on this workspace.
## Related endpoints
* [List Webhooks](/docs/api-reference/v1/webhooks/list): see every webhook in the workspace.
* [Update Webhook](/docs/api-reference/v1/webhooks/update): change the URL, events, or active status.
* [Delete Webhook](/docs/api-reference/v1/webhooks/delete): permanently remove the subscription.
* [Webhook secrets](/docs/api-access/webhook-secrets): how the signing secret is used.
## OpenAPI
````yaml GET /v1/user-webhooks/{id}
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/{id}:
get:
tags:
- User Webhooks
- User Webhooks V1
- V1
summary: Get Webhook Details
description: >-
Returns one webhook registration; its signing secret is masked after
creation.
operationId: UserWebhooksV1Controller_findOne
parameters:
- name: id
required: true
in: path
description: Webhook ID
schema:
type: string
example: webhook_abc123
responses:
'200':
description: Webhook returned successfully.
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Webhook fetched successfully
webhook:
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: '********'
createdAt:
type: string
format: date-time
examples:
success:
summary: Successful response
value:
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
'404':
description: Webhook not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 404 Not Found
value:
statusCode: 404
message: Webhook not found
error: Not Found
'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
````