Update Webhook - DialNexa Documentation

PATCH

user-webhooks

{id}

Update Webhook

curl --request PATCH \
  --url https://api.dialnexa.com/v1/user-webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_active": false
}
'

import requests

url = "https://api.dialnexa.com/v1/user-webhooks/{id}"

payload = { "is_active": False }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({is_active: false})
};

fetch('https://api.dialnexa.com/v1/user-webhooks/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/v1/user-webhooks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'is_active' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dialnexa.com/v1/user-webhooks/{id}"

	payload := strings.NewReader("{\n  \"is_active\": false\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.dialnexa.com/v1/user-webhooks/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"is_active\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/user-webhooks/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"is_active\": false\n}"

response = http.request(request)
puts response.read_body

{
  "id": "webhook_abc123",
  "url": "https://example.com/dialnexa/webhook",
  "events": [
    "call.completed"
  ],
  "is_active": false,
  "createdAt": "2026-07-03T10:30:00.000Z"
}

{
  "statusCode": 400,
  "message": "url must be a valid URL",
  "error": "Bad Request"
}

{
  "statusCode": 401,
  "message": "API key is missing or invalid",
  "error": "Unauthorized"
}

{
  "statusCode": 403,
  "message": "You do not have permission to access this resource",
  "error": "Forbidden"
}

{
  "statusCode": 404,
  "message": "Webhook not found",
  "error": "Not Found"
}

{
  "statusCode": 500,
  "message": "Internal server error",
  "error": "Internal Server Error"
}

Changes state - verify before retry

Recommended. This endpoint is part of the public /v1 API reference and is the supported path for new integrations. See the migration guide for versioning guidance.

Updates a registered webhook subscription. You can change the delivery url, add or remove events, rotate the signing secret, or toggle is_active to temporarily pause delivery. Only the fields you include are updated, omitted fields keep their current values. The subscription’s id does not change, so consumers can continue to reference the same webhook ID after the update.

When to use this

URL change: your consumer service moved to a new host or path.
Adding events: you started building a feature that needs an additional event type and want it delivered to the existing endpoint.
Removing events: your consumer no longer cares about a particular event and you want to stop the unnecessary deliveries.
Secret rotation: your signing secret leaked, expired, or you are on a periodic rotation cadence.
Temporary pause: you want to stop receiving events without losing the subscription. Set is_active to false, then back to true later. If you do not plan to re-enable, use Delete Webhook instead.

Rotating the signing secret

The public contract does not promise a dual-secret overlap window. Rotate as if the new value can take effect immediately:

Update your consumer service to accept both the old and new secret during a transition window.
Send the new secret to DialNexa through this endpoint.
Confirm new deliveries are being verified with the new secret.
Remove the old secret from your consumer service.

See Webhook secrets for the verification format and helper code.

Path parameters

Parameter	Description
`id`	The webhook ID, for example `whk_c9v3nz8rq4pm`.

Errors

404 Not Found is returned when the webhook does not exist.
400 Bad Request is returned when the URL is malformed or an event type is unknown.

List Webhooks: review every webhook on the workspace.
Delete Webhook: permanently remove a subscription.
Webhook secrets: verification format.
Webhook retries and failures: how DialNexa handles delivery failures.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Webhook ID

Example:

"webhook_abc123"

Body

application/json

url

string

The new URL for the webhook.

Example:

"https://webhook.site/updated-endpoint"

events

string[]

Updated list of events.

Example:

["order.paid"]

is_active

boolean

Whether the webhook is active.

Example:

false

secret

string

New secret for signing payloads.

Example:

"newSecret"

Response

Webhook updated successfully.

message

string

Example:

"Webhook updated successfully"

webhook

object

Show child attributes

Delete WebhookDelete a webhook endpoint.

Update Webhook

curl --request PATCH \
  --url https://api.dialnexa.com/v1/user-webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_active": false
}
'

import requests

url = "https://api.dialnexa.com/v1/user-webhooks/{id}"

payload = { "is_active": False }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({is_active: false})
};

fetch('https://api.dialnexa.com/v1/user-webhooks/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/v1/user-webhooks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'is_active' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dialnexa.com/v1/user-webhooks/{id}"

	payload := strings.NewReader("{\n  \"is_active\": false\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.dialnexa.com/v1/user-webhooks/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"is_active\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/user-webhooks/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"is_active\": false\n}"

response = http.request(request)
puts response.read_body

{
  "id": "webhook_abc123",
  "url": "https://example.com/dialnexa/webhook",
  "events": [
    "call.completed"
  ],
  "is_active": false,
  "createdAt": "2026-07-03T10:30:00.000Z"
}

{
  "statusCode": 400,
  "message": "url must be a valid URL",
  "error": "Bad Request"
}

{
  "statusCode": 401,
  "message": "API key is missing or invalid",
  "error": "Unauthorized"
}

{
  "statusCode": 403,
  "message": "You do not have permission to access this resource",
  "error": "Forbidden"
}

{
  "statusCode": 404,
  "message": "Webhook not found",
  "error": "Not Found"
}

{
  "statusCode": 500,
  "message": "Internal server error",
  "error": "Internal Server Error"
}

​When to use this

​Rotating the signing secret

​Path parameters

​Errors

​Related endpoints

Authorizations

Path Parameters

Body

Response

When to use this

Rotating the signing secret

Path parameters

Errors

Related endpoints