Listar Webhooks

Permite obtener un listado paginado de los webhooks configurados, con posibilidad de filtrar y ordenar los resultados.

---

Endpoint

GET

https://app.firmeasy.legal/api/v1/webhooks

---

Headers requeridos

Nombre	Tipo	Descripción	Límites
Authorization *	string	Token de acceso obtenido en el login, con el prefijo 'Bearer'.	Obligatorio
Content-Type	string	Especifica el tipo de contenido del cuerpo de la solicitud HTTP. Para las peticiones que incluyen datos JSON	'application/json'

---

Parámetros de búsqueda (Query Params)

Nombre	Tipo	Descripción	Límites
per_page	integer	Número de resultados por página.	Opcional
page	integer	Número de página actual.	Opcional
document_token	string	Filtra webhooks asociados a un documento específico.	Opcional
sort_by	string	Campo por el cual ordenar (por defecto created_at).	Opcional
sort_order	string	Orden de resultados: asc o desc.	Opcional
event	string	Filtra por tipo de evento configurado (ej: document_created, signer_rejected).	Opcional
active	boolean	Filtra por webhooks activos o inactivos.	Opcional

---

Ejemplo de respuesta

{
  "items": [
    {
      "id": "c71d4e53-28f2-4a17-9b82-6f3a9a2e4d97",
      "user": "e4f9b215-6a2d-49b0-a76a-8f25d73f9d3e",
      "document": null,
      "event": "signer_rejected",
      "target_url": "https://hooks.empresaglobal.com/events/c71d4e53-28f2-4a17-9b82-6f3a9a2e4d97",
      "active": true,
      "secret_key": "3K92MQLX7FJ0P1V8H6RC5T4YNE",
      "custom_headers": null,
      "signed_headers": null,
      "type": "E",
      "created_at": "2024-11-22T14:45:10.000000Z",
      "updated_at": "2024-11-22T14:45:10.000000Z"
    }
  ],
  "pagination": {
    "total_items": 2,
    "total_pages": 2,
    "current_page": 1,
    "per_page": 1,
    "next_page_url": "https://api.empresaglobal.com/v1/webhooks?per_page=1&page=2",
    "first_page_url": "https://api.empresaglobal.com/v1/webhooks?per_page=1&page=1",
    "last_page_url": "https://api.empresaglobal.com/v1/webhooks?per_page=1&page=2"
  }
}

---

Campos devueltos (por cada webhook)

Nombre	Tipo	Descripción
id	string	Identificador único del webhook en Firmeasy.
user	string	ID del usuario propietario del webhook.
document	string/null	Documento asociado si aplica, o null.
event	string	Evento configurado que disparará el webhook.
target_url	string	URL destino configurada.
active	boolean	Indica si el webhook está activo.
secret_key	string	Clave secreta única que sirve para firmar los payloads con HMAC.
custom_headers	array/null	Cabeceras personalizadas a enviar.
signed_headers	array/null	Headers firmados (por ahora null).
type	string/null	Tipo de webhook (reservado para uso futuro).
created_at	datetime	Fecha de creación.
updated_at	datetime	Última actualización.

---

Campos de paginación

La respuesta incluye un objeto pagination con información detallada para gestionar la navegación entre páginas:

Nombre	Tipo	Descripción
total_items	integer	Cantidad total de registros disponibles en la consulta.
total_pages	integer	Número total de páginas calculadas según la cantidad de elementos por página
current_page	integer	Número de la página actual que se está visualizando.
per_page	integer	Cantidad máxima de elementos devueltos por página.
next_page_url	string/null	URL para la siguiente página, si existe.
first_page_url	string	URL de la primera página.
last_page_url	string	URL de la última página.

---