Actualizá el método de autenticación y las credenciales de un webhook usando su client_hook_id.

Antes de empezar

1. Tené a mano el client_hook_id del webhook que querés actualizar.
2. Definí el valor de auth según el método de autenticación que quieras usar.
3. Enviá el objeto o arreglo credentials con el formato correspondiente al método elegido.
4. Tené en cuenta que los valores dentro de credentials son case sensitive.

Cómo actualizar las credenciales de un webhook

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

Path parameters

Body parameters

El body acepta un objeto ClientUpdateCredentialsInput.

Valores posibles para auth

• bearer: autenticación mediante Bearer Token
• basic: autenticación mediante usuario y contraseña
• header_token: autenticación mediante tokens enviados en headers personalizados

Ejemplo de request para bearer

{
  "auth": "bearer",
  "credentials": {
    "token": "my_token"
  }
}

Ejemplo de request para basic

{
  "auth": "basic",
  "credentials": {
    "username": "my_user",
    "password": "my_password"
  }
}

Ejemplo de request para header_token

{
  "auth": "header_token",
  "credentials": [
    {
      "header": "X-Authorization-APIBroker",
      "token": "ThisIsMyToken"
    },
    {
      "header": "X-Secondary-Token",
      "token": "AnotherToken"
    }
  ]
}

Qué devuelve este endpoint

La respuesta devuelve un arreglo items. Cada elemento representa la configuración actualizada del 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, auth o credentials tienen un formato inválido.

Siguiente paso

Después de actualizar las credenciales, verificá la configuración completa con GET /api/notifications/client-hooks/{client_hook_id}.