Eliminar webhook

DELETE /v1/webhooks/{id}

Elimina un webhook de forma inmediata. Una vez eliminado, el endpoint dejará de recibir eventos.

Pruébalo

Prueba este endpoint de forma interactiva en la Swagger UI.

Autorización requerida

Incluye tu clave API en el encabezado Authorization.

DANGER

La eliminación de un webhook es inmediata y permanente. El endpoint dejará de recibir eventos de forma inmediata. Esta acción no se puede deshacer -- necesitarás crear un nuevo webhook.

Solicitud

Encabezados

Encabezado	Valor	Requerido
Authorization	Bearer <token>	Sí

Parámetros de ruta

Parámetro	Tipo	Requerido	Descripción
id	string	Sí	El ID del webhook a eliminar (por ejemplo, webhook-abc123def456).

Ejemplos de código

curl

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

TypeScript

const apiKey = process.env.DOCMAP_API_KEY
const webhookId = 'webhook-abc123def456'

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

const result = await response.json()
console.log(result) // { success: true }

Python

import requests

api_key = "dm_live_abc123def456ghi789jkl012mno345"
webhook_id = "webhook-abc123def456"

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

print(response.json())  # {"success": True}

Respuesta

Estado: 200 OK

Ejemplo

{
  "success": true
}

Errores

Estado	Código	Descripción
401	UNAUTHORIZED	Clave API / token faltante, inválido o expirado.
403	FORBIDDEN	El webhook pertenece a un usuario diferente. Solo puedes eliminar tus propios webhooks.
404	NOT_FOUND	No se encontró ningún webhook con el ID especificado.