get
https://{defaultHost}/api/v4/tasks/webhooks/
Returns a webhook by ID.
The Get webhook endpoint returns information for a single webhook configured in your contact center.
Requirements: Base URL, Authentication, Error codes
Scope: tasks.webhooks.read
What this does
When you send a Get webhook request with a webhook ID,
Voiso
returns the webhook object, including its URL, authentication method, headers, and subscribed events.
Endpoint
GET /api/v4/tasks/webhooks/{webhook_id}Path parameters
- webhook_id
The unique identifier of the webhook (UUID).
Example request
curl -X GET "https://{cluster_id}.voiso.com/api/v4/tasks/webhooks/0b97ce11-b6e0-49b4-8f92-68040aa324bf" \
-H "Authorization: Bearer <contact_center_api_key>" \
-H "Content-Type: application/json"Response
If successful, the API returns a webhook object.
{
"webhook": {
"id": "0b97ce11-b6e0-49b4-8f92-68040aa324bf",
"name": "CRM call events",
"http_method": "post",
"url": "https://example.com/webhook",
"authentication_method": "basic",
"headers": {
"X-Custom-Header": "value"
},
"events": [
"inbound.call.answered",
"outbound.call.answered"
],
"created_at": "2025-01-15T10:30:00.000000Z",
"updated_at": "2025-01-15T10:30:00.000000Z"
}
}Notes
- You can get the webhook ID by using the List webhooks endpoint.
Troubleshooting
401 Unauthorized
Returned if the API key is missing or invalid.
403 Forbidden
Returned if the API key does not have access to Tasks resources.
404 Not found
Returned if the webhook ID does not exist or is not accessible.
429 Too many requests
Returned if requests are rate limited.