Nombre del servicio
GET https://api.envialosimple.email/api/v1/webhooks
Método de autenticación
Authorization: Bearer <clave API>
Para más detalle sobre cómo generar clave API ver: Cómo enviar mails desde la API
Descripción
Devuelve la lista de los webhooks asociados al dominio.
Parámetros
| Nombre | Tipo | Descripción |
| page | Integer | Número de página. Por defecto: 1. |
| limit | Integer | Cantidad de registros por página. Por defecto: 10. Máximo: 100. |
| sort | string | Ordenar por. Valores posibles: name/created_date. Por defecto: created_date. |
| direction | string | Tipo de ordenamiento. Valores posibles: asc/desc. Por defecto: desc. |
| filters | string | Expresión para filtrar los registros. Ver detalle de la Generación de expresiones (*). |
Respuesta
| Campo | Descripción |
| id | ID del webhook. |
| name | Nombre del webhook. |
| url | Dirección para enviar tus notificaciones |
| events |
Eventos para recibir notificaciones. Valores: processed > Procesado sent > Entregado read > Abierto rejected_soft > Rebote blando rejected_hard > Rebote duro failed > Falla de envío click > Cliqueado excluded > Excluido complaint > Queja |
| security_method | Método de seguridad utilizado. |
| created_date | Fecha de creación. Zona horaria UTC+00:00. |
Ejemplo de respuesta
{
"page": 1,
"limit": 10,
"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"
}
],
"total": 3