Skip to main content
GET
/
v1
/
webhooks
/
{webhookId}
Get Webhook
curl --request GET \
  --url https://api.sigmamind.ai/v1/webhooks/{webhookId} \
  --header 'X-API-Key: <api-key>'
{
  "workspaceId": "org_BUbkx3PsbzQm5V10",
  "webhookId": "wh_BUbkx3PsbzQm5V10",
  "name": "My Webhook",
  "agentId": "D5D0p7TUs66TTAEAx",
  "active": true,
  "secret": "mK9vXq2pL8nR5tY1wA3sD6fH0jC4bE7u",
  "events": "conversation_started, conversation_ended, conversation_analysed",
  "url": "https://example.com/webhook"
}

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
webhookId
string
required

A unique identifier for the webhook.

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

​
secret
string

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

Example:

"mK9vXq2pL8nR5tY1wA3sD6fH0jC4bE7u"

​
events
enum<string>[]

Specifies the list of events that trigger the webhook.

Available options:
conversation_started, conversation_ended, conversation_analysed
​
url
string

The HTTPS endpoint to which the webhook payload will be sent.

Example:

"https://example.com/webhook"