EnvíaloSimple Transaccional — API: Listar webhooks

Endpoint

GET https://api.envialosimple.email/api/v1/webhooks

Autenticación

Authorization: Bearer <clave API>

Descripción

Devuelve la lista de webhooks asociados al dominio.

Parámetros

Nombre	Tipo	Descripción
page	Integer	Número de página. Por defecto: 1.
limit	Integer	Registros por página. Por defecto: 10. Máximo: 100.
sort	String	Ordenar por: name, created_date. Por defecto: created_date.
direction	String	Ordenamiento: asc (ascendente), desc (descendente). Por defecto: desc.
filters	String	Expresión para filtrar registros. Ver Generación de expresiones.

Respuesta

Campo	Descripción
id	ID del webhook
name	Nombre del webhook
url	URL de destino de las notificaciones
events	Eventos configurados: processed, sent, read, rejected_soft, rejected_hard, failed, click, excluded, complaint
security_method	Método de seguridad utilizado
created_date	Fecha de creación (UTC+00:00)

Errores

Error	Descripción
malformed_filter	Expresión de filtro incorrecta
invalid_page	Número de página incorrecto — debe ser entero positivo
invalid_limit	Cantidad de registros incorrecta — debe ser entero positivo

Ejemplo de respuesta

{
  "page": 1,
  "limit": 10,
  "total": 3,
  "payload": [
    {
      "id": "65f8793c0bb9be645f0d3192",
      "name": "Procesados y enviados",
      "url": "https://ejemplo.com",
      "events": ["processed", "sent"],
      "security_method": "signing_key",
      "created_date": "2024-03-18T17:26:20+00:00"
    },
    {
      "id": "64d22e871f411dd843018875",
      "name": "Rechazados",
      "url": "https://ejemplo.com",
      "events": ["rejected_soft", "rejected_hard"],
      "security_method": "signing_key",
      "created_date": "2023-08-08T12:01:11+00:00"
    },
    {
      "id": "64cd4a73e09db4c0ae00a017",
      "name": "Queja",
      "url": "https://ejemplo.com",
      "events": ["complaint"],
      "security_method": "signing_key",
      "created_date": "2023-08-04T18:58:59+00:00"
    }
  ]
}