GetOTP Documentation

Update Webhook

The Webhooks API provides a way to update your Webhooks.

Request for Update Webhook API

To update a Webhook, make a PUT request to our Webhook endpoint.

https://api.otp.dev/v1/webhooks/{webhook_id}

With the following Basic HTTP verification method:

With the following parameter:

Examples

Below is an example request using cURL:

curl --request PUT \
    --url https://api.otp.dev/v1/webhooks/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
    --header 'X-OTP-Key: {YOUR_API_KEY}' \
    --header 'accept: application/json' \
    --header 'content-type: application/json' \
    --data '
    {
        "data": {
            "url": "https://example.com",
            "secret": "1234567890",
            "name": "My Webhook"
        }
    }
'

The response would be a JSON structure, returned with HTTP 200 Codestatus code:

{
    "data": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "url": "https://example.com",
        "secret": "1234567890",
        "event": "DELIVERY",
        "name": "My Webhook",
        "channel": "SMS",
        "create_date": "2025-10-13 05:47:42",
        "update_date": "2025-10-13 05:47:42",
        "links": {
            "self": "string",
            "account": "string"
            }
        }
}

Response data details:

If there is an error with the API call, you will receive a JSON response with 400+ status code, error code and message.

{
    "errors": [{
        "timestamp": "2025-08-18 00:00:00",
        "path": "/v1/webhooks/3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "method": "PUT",
        "status": 404,
        "message": "Webhook not found",
        "code": "1201"
    }]
}

Please refer to this table for details: