Skip to main content
POST
/
api
/
v1
/
appuid
/
{appUid}
/
webhooks
Create a new webhook configuration. Maximum of 50 webhooks per app.
curl --request POST \
  --url https://a.api.mindset.ai/api/v1/appuid/{appUid}/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "<string>",
  "entities": [
    "agent"
  ],
  "name": "<string>",
  "active": true
}
'
{
  "uid": "<string>",
  "name": "<string>",
  "url": "<string>",
  "secret": "<string>",
  "entities": [
    "<string>"
  ],
  "active": true,
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
appUid
string
required

Your application's uid

Minimum string length: 1

Body

application/json
​
url
string
required

Webhook endpoint URL

Required string length: 1 - 500
​
entities
enum<string>[]
required

Entity types to monitor

Required array length: 1 - 10 elements
Available options:
agent,
context,
contextfile
​
name
string

Descriptive name for the webhook

Maximum string length: 50
​
active
boolean

Whether the webhook is active (defaults to true)

Response

Webhook created successfully

​
uid
string

Unique ID of the webhook

​
name
string

Descriptive name for the webhook

​
url
string

Webhook endpoint URL

​
secret
string

HMAC secret for signature validation (only shown on creation)

​
entities
string[]

Entity types to monitor

​
active
boolean

Whether the webhook is active

​
createdAt
string<date-time>

Creation timestamp (ISO 8601)