Skip to main content
POST
/
v1
/
webhooks
Crear webhook
curl --request POST \
  --url https://api-prod.studio.getsupervisor.ai/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "url": "<string>",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "isActive": true,
  "headers": {},
  "secret": "<string>",
  "method": "POST"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "method": "POST",
  "secretPreview": "<string>",
  "lastDeliveryAt": "2023-11-07T05:31:56Z",
  "headers": {},
  "successCount": 1,
  "failureCount": 1
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-workspace-id
string<uuid>
required

Identificador del workspace multi-tenant.

Body

application/json
​
url
string<uri>
required

Debe ser https.

​
agentId
string<uuid> | null

Identificador del agente asociado cuando aplica.

​
description
string | null
Maximum string length: 500
​
isActive
boolean
default:true
​
headers
object
​
secret
string

Secreto HMAC opcional proporcionado por el cliente. Si se omite, el backend genera uno.

​
method
enum<string>
default:POST

Método HTTP para entregar eventos del webhook

Available options:
GET,
POST

Response

Created

​
id
string<uuid>
required
​
url
string<uri>
required

Debe ser https.

​
isActive
boolean
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
agentId
string<uuid> | null

Identificador del agente asociado cuando aplica.

​
description
string | null
Maximum string length: 500
​
method
enum<string>
default:POST

Método HTTP para entregar eventos del webhook

Available options:
GET,
POST
​
secretPreview
string | null

Vista previa enmascarada del secreto (prefix...suffix).

​
lastDeliveryAt
string<date-time> | null
​
headers
object

Headers permitidos (allowlist). Nunca incluir Authorization.

​
successCount
integer<int32>
Required range: x >= 0
​
failureCount
integer<int32>
Required range: x >= 0