Skip to main content
POST
/
v1
/
webhooks
Create Webhook
curl --request POST \
  --url https://api.sigmamind.ai/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Call Events - Production",
  "agentId": "D5D0p7TUs66TTAEAx",
  "url": "https://yourapp.com/webhooks/sigmamind",
  "events": [
    "conversation_started",
    "conversation_ended"
  ]
}
'
{
  "workspaceId": "org_BUbkx3PsbzQm5V10",
  "webhookId": "wh_BUbkx3PsbzQm5V10",
  "name": "Call Events - Production",
  "agentId": "D5D0p7TUs66TTAEAx",
  "active": true,
  "secret": "mK9vXq2pL8nR5tY1wA3sD6fH0jC4bE7u",
  "events": "conversation_started",
  "url": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.sigmamind.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Authenticate every request by passing your API key in the X-API-Key header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.

Body

application/json

Request body to register a new webhook. A webhook delivers real-time event notifications to your server via HTTP POST whenever selected events occur on an agent. The receiving endpoint must be publicly reachable over HTTPS and return HTTP 2xx to acknowledge delivery.

​
name
string
required

Human-readable name for this webhook. Used to identify it in listings and dashboards. Does not need to be unique, but a descriptive name helps distinguish multiple webhooks on the same agent.

Required string length: 1 - 128
Example:

"Call Events - Production"

​
agentId
string
required

Unique identifier of the agent this webhook is scoped to. Only events originating from this agent will be delivered to this webhook's URL. Use the agentId returned when the agent was created.

Required string length: 1 - 64
Example:

"D5D0p7TUs66TTAEAx"

​
url
string
required

HTTPS endpoint that will receive event payloads as HTTP POST requests. Must be publicly reachable. The system expects an HTTP 2xx response within the configured timeout to confirm delivery. Non-2xx responses or timeouts are treated as delivery failures.

Pattern: https?://.+
Example:

"https://yourapp.com/webhooks/sigmamind"

​
events
enum<string>[]
required

Set of event types that will trigger a delivery to this webhook. 'conversation_started' fires when an agent session begins. 'conversation_ended' fires when a session closes. 'conversation_analysed' fires when post-call analysis is complete. At least one event must be specified. Only events in this set will be sent — all others are silently ignored.

Set of event types that will trigger a delivery to this webhook. 'conversation_started' fires when an agent session begins. 'conversation_ended' fires when a session closes. 'conversation_analysed' fires when post-call analysis is complete. At least one event must be specified. Only events in this set will be sent — all others are silently ignored.

Available options:
conversation_started,
conversation_ended,
conversation_analysed
Example:
[
  "conversation_started",
  "conversation_ended"
]

Response

Created

Full details of a registered webhook. Includes delivery target, the agent it is scoped to, active status, subscribed events, and the secret used to verify payload authenticity.

​
workspaceId
string

Unique identifier of the workspace this webhook belongs to. Use this value to scope queries or filter webhooks by workspace.

Example:

"org_BUbkx3PsbzQm5V10"

​
webhookId
string

Unique identifier for this webhook. Use this value as webhookId when updating, deleting, or retrieving this webhook via the API.

Example:

"wh_BUbkx3PsbzQm5V10"

​
name
string

Display name of this webhook as set at creation time. Used to identify it in listings and dashboards.

Example:

"Call Events - Production"

​
agentId
string

Unique identifier of the agent this webhook is scoped to. Only events originating from this agent are delivered to this webhook's URL.

Example:

"D5D0p7TUs66TTAEAx"

​
active
boolean

Whether this webhook is currently active and will receive event deliveries. When false, the webhook is registered but no events are sent to the URL. Toggle this to pause or resume delivery without deleting the webhook.

Example:

true

​
secret
string

HMAC secret key used to sign outgoing webhook payloads. The system includes a signature header on each delivery computed using this secret. Verify the signature on your server to confirm payloads are genuinely from SigmaMind. Store this value securely — it is only returned at creation time.

Example:

"mK9vXq2pL8nR5tY1wA3sD6fH0jC4bE7u"

​
events
enum<string>[]

Event types this webhook is subscribed to. Only events in this list trigger a delivery to the webhook URL. 'conversation_started' fires when an agent session begins. 'conversation_ended' fires when a session closes. 'conversation_analysed' fires when post-call analysis is complete.

Event types this webhook is subscribed to. Only events in this list trigger a delivery to the webhook URL. 'conversation_started' fires when an agent session begins. 'conversation_ended' fires when a session closes. 'conversation_analysed' fires when post-call analysis is complete.

Available options:
conversation_started,
conversation_ended,
conversation_analysed
​
url
string