VOvoicepanel
Webhooks

Get a webhook endpoint

Retrieve a single webhook endpoint by its ID.

get/api/v1/webhook_endpoints/{endpoint_id}

Request

  • Base URL
    https://app.voicepanel.com
  • URL
    https://app.voicepanel.com/api/v1/webhook_endpoints/{endpoint_id}
  • Auth
    HTTP bearer

Path parameters

endpoint_idstring required
Example:whep_9Lm2Xc7VqT4bRn

The webhook endpoint ID

Response

Successful response

idstring required

The webhook endpoint ID

account_idstring required

The account that owns the endpoint

urlstring required

HTTPS URL that receives a POST for each event

descriptionstring nullable required

A label shown in the dashboard

event_typesstring[] required

Event types the endpoint receives

enabledboolean required

False when deliveries are stopped, by you or after failures

disabled_atstring date-time nullable required

When the endpoint was disabled

disabled_reason'endpoint_returned_410' | 'failing_for_7_days' | 'manual' nullable required

Why the endpoint was disabled

consecutive_failuresinteger required

Failed deliveries since the last success

last_success_atstring date-time nullable required
last_failure_atstring date-time nullable required
previous_secret_expires_atstring date-time nullable required

After a rotation, when deliveries stop carrying the previous signature

created_bystring nullable required

ID of the user who created the endpoint

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "id": "whep_9Lm2Xc7VqT4bRn",
  "account_id": "acct_7Kq2mVbXpR4nZa",
  "url": "https://example.com/webhooks/voicepanel",
  "description": "CRM sync",
  "event_types": [
    "response.completed"
  ],
  "enabled": true,
  "last_success_at": "2026-03-09T18:45:02.000Z",
  "created_by": "0f1b3c6e-9d2a-4b7c-8e5f-2a1d4c6b8e90",
  "created_at": "2026-02-20T10:00:00.000Z",
  "updated_at": "2026-03-09T18:45:02.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.