Update Webhook

PUT

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

Webhooks

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

Performs a complete update of an existing webhook configuration. All fields in the request body overwrite the currently stored values.

Important
This is a full update operation (PUT). All required fields must be provided, even if unchanged. For partial updates, use PATCH /webhooks/:id instead.

Validation

webhook_endpoint must be a valid HTTPS URL

Webhook must exist and not be in deleted state

All required fields (webhook_name, webhook_endpoint, format, method) must be provided

Preserved fields

webhook_id — Cannot be changed

webhook_created — Original creation timestamp is preserved

webhook_updated — Automatically set to current timestamp

Behavior

Webhook remains active during update unless explicitly changed via webhook_status

Event delivery continues uninterrupted

Static parameters are completely updated with the new array (not merged)

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Webhook updated successfully

Bodyapplication/json

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff --request PUT 'https://platform-api.convirza.com/v3/webhooks/{id}' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "webhook_name": "Lead Webhook",
    "webhook_endpoint": "https://example.com/webhook",
    "description": "Webhook for lead notifications",
    "format": "JSON",
    "method": "GET",
    "include_data_append": true,
    "include_dni_logs": false,
    "include_indicator_scores": true,
    "include_ivr_keypresses": false,
    "webhook_status": "active",
    "static_parameters": [
        {
            "field_name": "api_key",
            "field_value": "sk_live_1234567890"
        }
    ]
}'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "webhookId": 123
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

Modified at 2026-07-24 13:10:44

List Webhooks

Partial Update Webhook