Webhooks

Create Webhook

Registers a webhook URL for your workspace. The response is the only one that returns the plain secret; store it securely. DialNexa sends one signed POST when a call that was not started by a batch call ends, with no retry and no timeout. The x-nexa-signature header is sha256=<hex>, an HMAC-SHA256 of the raw request body with your secret.

post/v1/user-webhooks

Request

  • Base URL: https://api.dialnexa.com
  • URL: https://api.dialnexa.com/v1/user-webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required

The URL to which webhook events will be sent.

eventsstring[] required

List of events this webhook is subscribed to.

is_activeboolean

Whether the webhook is active.

secretstring required

Secret used to sign webhook payloads.

Example request

{
  "url": "https://webhook.site/your-endpoint",
  "events": [
    "call.completed"
  ],
  "is_active": true,
  "secret": "replace-with-a-long-random-secret"
}

Response

Webhook created successfully.

successtrue required
errorfalse required
statusCodeinteger required
messagestring required
timestampstring date-time required

Example response

{
  "statusCode": 201,
  "message": "Success",
  "data": {
    "message": "Webhook created successfully",
    "webhook": {
      "id": "webhook_c9v3nz8rq4pmxa",
      "org_id": "o14XKPP84rt22g",
      "url": "https://example.com/dialnexa/webhook",
      "events": [
        "call.completed"
      ],
      "is_active": true,
      "secret": "replace-with-a-long-random-secret"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.