Skip to main content

Overview

Create a webhook to receive real-time event notifications from Weya AI. Once configured, Weya AI automatically sends HTTP POST requests to your endpoint whenever the selected events occur. Webhooks can be used to integrate with CRMs, internal applications, analytics platforms, or other third-party services.

Prerequisites

  • Bearer Token authentication
  • A publicly accessible HTTPS endpoint
  • Endpoint capable of accepting POST requests

Request

string
required
Bearer token for authenticated workspace access.

Request Body

string
required
Display name for the webhook.
string
required
Public HTTPS endpoint that will receive webhook events.
array[string]
required
List of events that should trigger webhook notifications.Supported events include:
  • call.started
  • call.answered
  • call.completed
  • call.failed
  • call.transferred
  • call.recording.available
  • call.summary.generated
  • call.analysis.completed
string
Optional signing secret used to verify incoming webhook requests.
boolean
Enable or disable the webhook after creation.Default: true

Response

boolean
Indicates whether the request was successful.
integer
HTTP status code returned by the API.
string
Success message.
object
Information about the created webhook.
string
Unique identifier of the webhook.
string
Webhook display name.
string
Destination URL that receives webhook events.
array[string]
Subscribed webhook events.
boolean
Whether the webhook is enabled.
string
Webhook creation timestamp.

Error Handling

Your webhook endpoint should return an HTTP 200 OK response within a few seconds. If Weya AI does not receive a successful response, the webhook delivery may be retried.
After creating a webhook, you can:
  • View all registered webhooks.
  • Update webhook settings.
  • Enable or disable webhook delivery.
  • Delete the webhook when it is no longer required.