Create Webhook

POST

user-webhooks

Create Webhook

curl --request POST \
  --url https://api.dialnexa.com/v1/user-webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/dialnexa/webhook",
  "events": [
    "call.completed"
  ],
  "is_active": true,
  "secret": "replace-with-a-long-random-secret"
}
'

import requests

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

payload = {
    "url": "https://example.com/dialnexa/webhook",
    "events": ["call.completed"],
    "is_active": True,
    "secret": "replace-with-a-long-random-secret"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://example.com/dialnexa/webhook',
    events: ['call.completed'],
    is_active: true,
    secret: 'replace-with-a-long-random-secret'
  })
};

fetch('https://api.dialnexa.com/v1/user-webhooks', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://example.com/dialnexa/webhook',
    'events' => [
        'call.completed'
    ],
    'is_active' => true,
    'secret' => 'replace-with-a-long-random-secret'
  ]),
  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"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com/dialnexa/webhook\",\n  \"events\": [\n    \"call.completed\"\n  ],\n  \"is_active\": true,\n  \"secret\": \"replace-with-a-long-random-secret\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.dialnexa.com/v1/user-webhooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://example.com/dialnexa/webhook\",\n  \"events\": [\n    \"call.completed\"\n  ],\n  \"is_active\": true,\n  \"secret\": \"replace-with-a-long-random-secret\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://example.com/dialnexa/webhook\",\n  \"events\": [\n    \"call.completed\"\n  ],\n  \"is_active\": true,\n  \"secret\": \"replace-with-a-long-random-secret\"\n}"

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

{
  "id": "webhook_abc123",
  "url": "https://example.com/dialnexa/webhook",
  "events": [
    "call.completed"
  ],
  "is_active": true,
  "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": 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.

Registers a URL endpoint to receive event notifications. When a call ends, DialNexa sends an HTTP POST to your URL with a signed plain JSON payload. DialNexa does not encrypt the webhook body. The secret is required. Generate a long random value, store it in a secret manager, and send it only over HTTPS. The create response is the only response that exposes the unmasked value; later reads mask it.

Payload delivered when a call ends

{
  "call_id": "mrjurp82fXXDJr",
  "status": "completed",
  "sentiment": "positive",
  "summary": "The agent confirmed the appointment.",
  "transcript": "...",
  "extracted_data": { "name": "John", "intent": "book_appointment" },
  "duration": 120,
  "recording_url": "https://...",
  "agent_id": "agent_FBbwBB8Lof7Mtm",
  "metadata": { "call_id": null },
  "billing": {
    "total_amount_inr": 5.5,
    "billed_duration_seconds": 120,
    "billing_plan": { "id": "abc", "name": "Standard" },
    "line_items": [{ "item_type": "call", "rate_inr": 0.05, "units": 120, "amount_inr": 5.5 }]
  }
}

billing is only present for organizations on the new billing system.

Verifying the signature

Every delivery includes an x-nexa-signature header:

x-nexa-signature: sha256=<hex>

Computed as HMAC-SHA256(secret, rawBody) over the raw request body. Always verify against the raw body before parsing JSON.

Node.js

const crypto = require('crypto');

function verifySignature(rawBody, secret, signatureHeader) {
  if (!signatureHeader || !signatureHeader.startsWith('sha256=')) {
    return false;
  }

  const expected = 'sha256=' + crypto
    .createHmac('sha256', secret)
    .update(rawBody)
    .digest('hex');
  const expectedBuffer = Buffer.from(expected);
  const receivedBuffer = Buffer.from(signatureHeader);

  return expectedBuffer.length === receivedBuffer.length &&
    crypto.timingSafeEqual(expectedBuffer, receivedBuffer);
}

Python

import hmac, hashlib

def verify_signature(raw_body: bytes, secret: str, signature_header: str) -> bool:
    signature_header = signature_header or ''
    if not signature_header.startswith('sha256='):
        return False
    expected = 'sha256=' + hmac.new(secret.encode(), raw_body, hashlib.sha256).hexdigest()
    return hmac.compare_digest(expected, signature_header or '')

Some older webhook docs and legacy delivery paths use x-dialnexa-signature. For this /v1/user-webhooks call-ended delivery path, verify x-nexa-signature.

When to use this

Call outcome processing: get notified the moment a call ends instead of polling Get Call Details, then write the outcome to your CRM or trigger the next step.
Live dashboards: track call starts and completions in real time.

Available events

Event	Triggered when
`call.completed`	A call completes successfully.
`call.failed`	A call reaches a failure outcome.

Use only event strings accepted by the request schema. Event availability can vary as the catalog evolves; do not translate dots to underscores.

Authorizations

Authorization

string

header

required

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

Body

application/json

url

string

required

The URL to which webhook events will be sent.

Example:

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

events

string[]

required

List of events this webhook is subscribed to.

Example:

["order.paid", "order.failed"]

secret

string

required

Secret used to sign webhook payloads.

Example:

"mySuperSecret"

is_active

boolean

Whether the webhook is active.

Example:

true

Response

Webhook created successfully.

message

string

Example:

"Webhook created successfully"

webhook

object

Show child attributes

List WebhooksList webhook endpoints for your workspace.

Create Webhook

curl --request POST \
  --url https://api.dialnexa.com/v1/user-webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/dialnexa/webhook",
  "events": [
    "call.completed"
  ],
  "is_active": true,
  "secret": "replace-with-a-long-random-secret"
}
'

import requests

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

payload = {
    "url": "https://example.com/dialnexa/webhook",
    "events": ["call.completed"],
    "is_active": True,
    "secret": "replace-with-a-long-random-secret"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://example.com/dialnexa/webhook',
    events: ['call.completed'],
    is_active: true,
    secret: 'replace-with-a-long-random-secret'
  })
};

fetch('https://api.dialnexa.com/v1/user-webhooks', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://example.com/dialnexa/webhook',
    'events' => [
        'call.completed'
    ],
    'is_active' => true,
    'secret' => 'replace-with-a-long-random-secret'
  ]),
  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"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com/dialnexa/webhook\",\n  \"events\": [\n    \"call.completed\"\n  ],\n  \"is_active\": true,\n  \"secret\": \"replace-with-a-long-random-secret\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.dialnexa.com/v1/user-webhooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://example.com/dialnexa/webhook\",\n  \"events\": [\n    \"call.completed\"\n  ],\n  \"is_active\": true,\n  \"secret\": \"replace-with-a-long-random-secret\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://example.com/dialnexa/webhook\",\n  \"events\": [\n    \"call.completed\"\n  ],\n  \"is_active\": true,\n  \"secret\": \"replace-with-a-long-random-secret\"\n}"

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

{
  "id": "webhook_abc123",
  "url": "https://example.com/dialnexa/webhook",
  "events": [
    "call.completed"
  ],
  "is_active": true,
  "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": 500,
  "message": "Internal server error",
  "error": "Internal Server Error"
}

Overview

Endpoints - v1

Endpoints - Legacy

Code Examples And SDK Status

Payload delivered when a call ends

Verifying the signature

When to use this

Available events

Authorizations

Body

Response

​Payload delivered when a call ends

​Verifying the signature

​When to use this

​Available events

Authorizations

Body

Response

Payload delivered when a call ends

Verifying the signature

When to use this

Available events