Mindset v3 / Deploy in your app / Webhooks

Create a new webhook configuration. Maximum of 50 webhooks per app.

Mindset v3 REST API reference: Webhooks.

POST /api/v1/appuid/{appUid}/webhooks

Base URL

Requests go to your region's API host, for example https://a.api.mindset.ai. Hosts: https://a.api.mindset.ai, https://b.api.mindset.ai, https://c.api.mindset.ai, https://d.api.mindset.ai.

Authorization

x-api-keystringheaderrequired

Your API key.

Path parameters

appUidstringpathrequired

Your application's uid

Request body

Content type: application/json.

namestringbody

Descriptive name for the webhook

urlstringbodyrequired

Webhook endpoint URL

entitiesstring[]bodyrequired

Entity types to monitor

activebooleanbody

Whether the webhook is active (defaults to true)

json

{
  "name": "string",
  "url": "string",
  "entities": [
    "agent"
  ],
  "active": true
}

Responses

201

Webhook created successfully

json

{
  "uid": "string",
  "name": "string",
  "url": "string",
  "secret": "string",
  "entities": [
    "string"
  ],
  "active": true,
  "createdAt": "string"
}

400

Bad Request

401

Unauthorized

403

Forbidden

422

Unprocessable Entity - e.g. maximum number (50) of webhooks reached

500

Internal Server Error

Example request

bash

curl -X POST "https://a.api.mindset.ai/api/v1/appuid/{appUid}/webhooks" \
  -H "x-api-key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","url":"string","entities":["agent"],"active":true}'