List Webhooks

GET /v1/webhooks

List all active webhooks for the authenticated user. The response never includes signing secrets -- only metadata for identification and management.

Try it

Test this endpoint interactively in the Swagger UI.

Authorization required

Include your API key in the Authorization header.

Request

Headers

Header	Value	Required
Authorization	Bearer <token>	Yes

This endpoint takes no query parameters or request body.

Code Examples

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}")

Response

Status: 200 OK

The response body contains a data array of webhook metadata objects.

Fields

Each object in the array contains:

Field	Type	Description
id	string	Unique identifier for the webhook.
userId	string	ID of the user who owns the webhook.
url	string	The registered endpoint URL.
events	string[]	Events the webhook is subscribed to.
active	boolean	Whether the webhook is active. Always true in this response.
createdAt	string	ISO 8601 timestamp of when the webhook was created.

Example

{
  "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"
    }
  ]
}

Errors

Status	Code	Description
401	UNAUTHORIZED	Missing, invalid, or expired API key / token.