List Webhooks

GET

https://platform-api.convirza.com/v3/webhooks/list

Webhooks

Last modified:2026-04-03 14:27:57

Returns a paginated list of webhook configurations for the authenticated user's organization.

Scope
Results are automatically scoped to the authenticated user's org_unit_id. Webhooks are outbound notification endpoints that fire when specific call or SMS events occur in your account.

Filtering

webhook_name — partial, case-insensitive search against the webhook display name.

filter — legacy filter string for backward compatibility.

Pagination
Use limit (default: 100) and offset (default: 0) to page through results. The response includes a total count.

Response
Each webhook record includes its name, target URL, HTTP method, active status, event triggers, and creation/update timestamps.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200

application/json

Successfully retrieved webhooks list

Body

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://platform-api.convirza.com/v3/webhooks/list?org_unit_id&webhook_name&status&offset&limit&filter' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "webhooks": [
            {
                "webhook_id": 123,
                "webhook_name": "Lead Notification Webhook",
                "target_url": "https://api.example.com/webhooks/leads"
            },
            {
                "webhook_id": 124,
                "webhook_name": "Call Completed Webhook",
                "target_url": "https://api.example.com/webhooks/calls"
            }
        ],
        "total": 25
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

Modified at 2026-04-03 14:27:57

Create Group

Get Webhook Details