Skip to main content
PATCH
Actualizar webhook

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>

Identificador del workspace multi-tenant. Obligatorio al autenticar con Authorization: Bearer, donde su ausencia devuelve 400 Workspace context is required. Con x-api-key es opcional: la llave ya identifica a su workspace y lo que mandes aquí se ignora.

Path Parameters

webhookId
string<uuid>
required

Identificador del webhook (UUID v4)

Body

application/json
url
string<uri>

Debe ser https.

agentId
string<uuid> | null

Identificador del agente asociado cuando aplica.

description
string | null
Maximum string length: 500
isActive
boolean
headers
object

Headers adicionales. Si incluye Authorization, se persiste cifrado y nunca se devuelve en WebhookDetail.headers.

method
enum<string>

Método HTTP para entregar eventos del webhook

Available options:
GET,
POST

Response

OK

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). Si existe Authorization, se persiste cifrado por separado y se devuelve redacted (p.ej. ********). El valor real nunca se devuelve. Si el cliente reenvía el valor redacted, el backend lo trata como "sin cambios".

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