Update

Actualiza la URL de un webhook existente mediante su client_hook_id.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Actualizá la URL de un webhook existente usando su client_hook_id.

Antes de empezar

  1. Tené a mano el client_hook_id del webhook que querés actualizar.
  2. Prepará la nueva webhook_url y verificá que sea una URL válida.
  3. Usá este endpoint cuando necesites cambiar el destino donde querés recibir las notificaciones.

Cómo actualizar la URL de un webhook

PATCH /api/notifications/client-hooks/{client_hook_id}
Content-Type: application/json

Path parameters

ParámetroTipoRequeridoDescripción
client_hook_idintegerSíCódigo identificador del webhook que querés actualizar.

Body parameters

El body acepta un objeto ClientUpdateInput.

CampoTipoRequeridoDescripción
webhook_urlstringSíNueva URL del webhook.

Ejemplo de request

{
  "webhook_url": "https://www.domain.com/webhook/notifications"
}

Qué devuelve este endpoint

La respuesta devuelve un arreglo items. Cada elemento representa la configuración actualizada del webhook.

CampoTipoDescripción
client_hook_idintegerCódigo identificador del webhook.
usernamestringNombre del usuario o identificador asociado al webhook.
webhook_urlstringURL actualizada a la que se envían las notificaciones.
authstringMétodo de autenticación configurado.
topicsarray de objetosLista de tópicos suscritos a ese webhook.

Respuesta esperada

{
  "items": [
    {
      "client_hook_id": 10,
      "username": "webhook_user",
      "webhook_url": "https://www.domain.com/webhook/notifications",
      "auth": "bearer",
      "topics": [
        {
          "topic_id": 1
        },
        {
          "topic_id": 2
        }
      ]
    }
  ]
}

Errores frecuentes

  • 422 Validation Error: el client_hook_id o webhook_url tienen un formato inválido.

Siguiente paso

Si necesitás actualizar también el método o las credenciales de autenticación, usá PATCH /api/notifications/client-hooks/{client_hook_id}/credentials.

Path Params
integer
required
Body Params
uri
required
length between 1 and 65536

The client's webhook to send the notification to. WARNING! A URL can be case-sensitive

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json