List Webhooks

GET

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

Webhooks

Last modified:2026-07-24 13:10:44

Retrieves a paginated list of all webhooks configured for your organization.

Scope
Results are automatically filtered to the authenticated user's organization (org_unit_id).

Filtering options

status — Filter by webhook state: active, inactive, or deleted (default: active)

webhook_name — Case-insensitive partial match on webhook name

filter — Legacy filter parameter for backward compatibility

Pagination

limit — Maximum results per page (default: 100, max: 200)

offset — Number of records to skip (default: 0)

Response includes total count for all matching webhooks

Sorting

sort_by — Field to sort by (webhook_name, status, target_url) - default: webhook_name

sort_order — Sort direction (asc, desc) - default: asc

Response fields
Each webhook includes: ID, name, target URL, HTTP method, response format, status, inclusion flags, static parameters, and 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

Bodyapplication/json

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://platform-api.convirza.com/v3/webhooks?org_unit_id=&webhook_name=&status=&sort_by=&sort_order=&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-07-24 13:10:44

Get Webhook Details

Update Webhook