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": "wh_BUbkx3PsbzQm5V10",
  "agentId": "D5D0p7TUs66TTAEAx",
  "url": "https://example.com/webhook",
  "secret": "key_S7ULC2lBwbg.85ez_yKnXTG6I5OgDHwTBNMSOD2ZyyUFUuDgweVXcXE",
  "events": [
    "conversation_started"
  ]
}
'
{
  "workspaceId": "org_BUbkx3PsbzQm5V10",
  "webhookId": "wh_BUbkx3PsbzQm5V10",
  "name": "My Webhook",
  "agentId": "D5D0p7TUs66TTAEAx",
  "active": true,
  "events": "conversation_started, conversation_ended, conversation_analysed",
  "url": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

API Key is required in header. You can find it in the settings

Body

application/json
​
name
string
required

A unique identifier for the webhook.

Example:

"wh_BUbkx3PsbzQm5V10"

​
agentId
string
required

Unique identifier of the agent to which the webhook is associated.

Example:

"D5D0p7TUs66TTAEAx"

​
url
string
required

The HTTPS endpoint to which the webhook payload will be sent. Must be a valid HTTPS URL.

Example:

"https://example.com/webhook"

​
secret
string
required

Secret key used to authenticate webhook payloads. This key should be securely stored and verified on the receiving server.

Example:

"key_S7ULC2lBwbg.85ez_yKnXTG6I5OgDHwTBNMSOD2ZyyUFUuDgweVXcXE"

​
events
enum<string>[]
required

List of events that will trigger the webhook. Each event name corresponds to a specific type of activity in the system.

List of events that will trigger the webhook. Each event name corresponds to a specific type of activity in the system.

Available options:
conversation_started,
conversation_ended,
conversation_analysed

Response

OK

​
workspaceId
string

A unique identifier of the workspace.

Example:

"org_BUbkx3PsbzQm5V10"

​
webhookId
string

A unique identifier for the webhook.

Example:

"wh_BUbkx3PsbzQm5V10"

​
name
string

The display name of the webhook for easy identification.

Example:

"My Webhook"

​
agentId
string

The unique identifier of the agent to which the webhook is assigned.

Example:

"D5D0p7TUs66TTAEAx"

​
active
boolean

Indicates whether the webhook is currently active and able to receive events.

Example:

true

​
events
enum<string>[]

Specifies the list of events that trigger the webhook.

Specifies the list of events that trigger the webhook.

Available options:
conversation_started, conversation_ended, conversation_analysed
​
url
string