Listar webhooks

GET /v1/webhooks

Lista todos los webhooks activos del usuario autenticado. La respuesta nunca incluye secretos de firma -- solo metadatos para identificación y gestión.

Pruébalo

Prueba este endpoint de forma interactiva en la Swagger UI.

Autorización requerida

Incluye tu clave API en el encabezado Authorization.

Solicitud

Encabezados

Encabezado	Valor	Requerido
Authorization	Bearer <token>	Sí

Este endpoint no acepta parámetros de consulta ni cuerpo de solicitud.

Ejemplos de código

curl

curl https://api.docmap.io/v1/webhooks \
  -H "Authorization: Bearer dm_live_abc123def456ghi789jkl012mno345"

TypeScript

const apiKey = process.env.DOCMAP_API_KEY

const response = await fetch('https://api.docmap.io/v1/webhooks', {
  headers: { 'Authorization': `Bearer ${apiKey}` },
})

const { data } = await response.json()

for (const webhook of data) {
  console.log(`${webhook.url} — events: ${webhook.events.join(', ')}`)
}

Python

import requests

api_key = "dm_live_abc123def456ghi789jkl012mno345"

response = requests.get(
    "https://api.docmap.io/v1/webhooks",
    headers={"Authorization": f"Bearer {api_key}"},
)

webhooks = response.json()["data"]

for webhook in webhooks:
    events = ", ".join(webhook["events"])
    print(f"{webhook['url']} — events: {events}")

Respuesta

Estado: 200 OK

El cuerpo de la respuesta contiene un array data de objetos de metadatos de webhooks.

Campos

Cada objeto en el array contiene:

Campo	Tipo	Descripción
id	string	Identificador único del webhook.
userId	string	ID del usuario propietario del webhook.
url	string	La URL del endpoint registrado.
events	string[]	Eventos a los que el webhook está suscrito.
active	boolean	Si el webhook está activo. Siempre true en esta respuesta.
createdAt	string	Marca de tiempo ISO 8601 de cuándo se creó el webhook.

Ejemplo

{
  "data": [
    {
      "id": "webhook-abc123def456",
      "userId": "uid_a1b2c3d4e5f6",
      "url": "https://your-app.com/webhooks/docmap",
      "events": ["extraction.completed", "extraction.failed"],
      "active": true,
      "createdAt": "2025-01-15T10:00:00.000Z"
    },
    {
      "id": "webhook-xyz789uvw012",
      "userId": "uid_a1b2c3d4e5f6",
      "url": "https://slack-webhook.example.com/docmap",
      "events": ["extraction.failed"],
      "active": true,
      "createdAt": "2025-01-10T08:00:00.000Z"
    }
  ]
}

Errores

Estado	Código	Descripción
401	UNAUTHORIZED	Clave API / token faltante, inválido o expirado.