Actualizar un webhook

Sirve para cambiar la URL, los eventos, la descripción o los filtros de una suscripción, o para pausarla y reactivarla.

PUT
/webhooks/{id}

Reemplaza url, events, description y filters; status opcional

Escritura · requiere el permiso webhooks:write.

Con una clave de API, cada tipo de events exige además el permiso de lectura de su área (accounts:read, conversations:read, communities:read); si falta, 422.

Con una clave de API, la clave necesita además el permiso de lectura del área de cada tipo de evento que la suscripción tiene ahora; si falta alguno, 403 permission_denied y no se cambia nada. Un cuerpo inválido responde 422 antes de mirar la suscripción.

Si una clave de API cambia url, la suscripción queda atada a esa clave: cuando se revoque, pasa a disabled / key_revoked.

Autorización

http
headerAuthorizationBearer <clave>

Parámetros de la ruta

id*string

Cuerpo del pedido

application/json
  1. body

El cuerpo de PUT api/webhooks/{id}: reemplaza url, events, description y filters; status es opcional y solo admite active o paused (el cliente no puede dejarla disabled).

url*string
Formatouri
Largolength <= 2048
description?|
Largolength <= 160
events*array<>
Elementos1 <= items <= 50
filters?
status?string
Valor en"active""paused"

Cuerpo de la respuesta

application/json
  1. response
curl -X PUT "https://example.com/webhooks/string" \  -H "Content-Type: application/json" \  -d '{    "url": "http://example.com",    "events": [      "device.disconnected"    ]  }'
{}