Get Webhook Details

GET

https://platform-api.convirza.com/v3/webhooks/{id}

Webhooks

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

Fetches the complete configuration for a single webhook by its unique ID.

Returned data

Identity: webhook name, internal ID.

Delivery: target URL, HTTP method (POST/GET), custom request headers.

Authentication: any auth tokens or signatures configured for the target endpoint.

Triggers: the call/SMS events that cause this webhook to fire (e.g. call completed, call answered).

Payload template: the JSON body sent to the target URL on each event.

Retry configuration: number of retry attempts and backoff strategy on delivery failure.

Status: active/inactive, and last delivery timestamp.

Validation
The id must be a positive integer. Non-numeric, zero, or negative values are rejected with 400.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Responses

🟢200

application/json

Successfully retrieved webhook details

Body

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://platform-api.convirza.com/v3/webhooks/' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "webhook_id": 123,
        "webhook_name": "Lead Notification Webhook",
        "org_unit_id": 1001,
        "target_url": "https://api.example.com/webhooks/leads",
        "webhook_desc": "Sends lead data to CRM system",
        "webhook_created": "2026-01-01T10:00:00Z",
        "webhook_updated": "2026-02-01T15:30:00Z",
        "response_format": "JSON",
        "http_method": "POST",
        "include_data_append": false,
        "include_dni": true,
        "include_score": true,
        "include_ivr_keypresses": false,
        "webhook_status": "active",
        "static_parameters": [
            {
                "webhook_id": 123,
                "field_name": "api_key",
                "field_id": "",
                "field_value": "your-api-key",
                "map_order": 1
            }
        ]
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

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

List Webhooks

Update Webhook