Skip to main content
GET
/
user-webhooks
/
{id}
Get a webhook
curl --request GET \
  --url https://api.dialnexa.com/v1/user-webhooks/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "wh_abc123",
  "url": "https://yourapp.com/webhooks/dialnexa",
  "events": [
    "call.completed",
    "call.failed"
  ],
  "is_active": true,
  "created_at": "2024-03-01T10:00:00.000Z"
}
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; 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.
For the entire set of webhooks on the workspace, use List Webhooks.

Path parameters

ParameterDescription
idThe 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.

Request

curl "https://api.dialnexa.com/v1/user-webhooks/whk_c9v3nz8rq4pm" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "id": "whk_c9v3nz8rq4pm",
  "url": "https://yourapp.com/webhooks/dialnexa",
  "events": ["call.completed", "call.failed"],
  "is_active": true,
  "created_at": "2024-04-01T08:00:00.000Z"
}

Authorizations

Authorization
string
header
required

Pass your API key as a Bearer token in the Authorization header.

Path Parameters

id
string
required

Response

Success.

id
string
Example:

"wh_abc123"

url
string
Example:

"https://yourapp.com/webhooks/dialnexa"

events
string[]
Example:
["call.completed", "call.failed"]
is_active
boolean
Example:

true

created_at
string<date-time>
Example:

"2024-03-01T10:00:00.000Z"