Skip to main content
PATCH
/
api
/
v1
/
appuid
/
{appUid}
/
webhooks
/
uid
/
{uid}
Update a webhook by UID
curl --request PATCH \
  --url https://a.api.mindset.ai/api/v1/appuid/{appUid}/webhooks/uid/{uid} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "entities": [
    "agent"
  ],
  "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
uid
string
required

Unique ID of the webhook

Body

application/json
name
string

Descriptive name for the webhook

Maximum string length: 50
url
string

Webhook endpoint URL

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

Entity types to monitor

Required array length: 1 - 10 elements
Available options:
agent,
context,
contextfile
active
boolean

Whether the webhook is active

Response

Successful update

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

entities
string[]

Entity types to monitor

active
boolean

Whether the webhook is active

createdAt
string<date-time>

Creation timestamp (ISO 8601)