List Deliveries

GET /v1/webhooks/deliveries

List recent webhook delivery attempts for the authenticated user. Returns delivery logs ordered by most recent first, so you can monitor whether your webhooks are receiving events successfully.

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

Query Parameters

Parameter	Type	Default	Description
webhookId	string	—	Filter deliveries by a specific webhook ID.
limit	number	50	Maximum number of results to return (1–100).

Code Examples

curl

curl "https://api.docmap.io/v1/webhooks/deliveries?limit=10" \
  -H "Authorization: Bearer dm_live_abc123def456ghi789jkl012mno345"

TypeScript

const apiKey = process.env.DOCMAP_API_KEY

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

const { data } = await response.json()

for (const delivery of data) {
  console.log(`${delivery.event} → ${delivery.url} — ${delivery.status} (${delivery.durationMs}ms)`)
}

Python

import requests

api_key = "dm_live_abc123def456ghi789jkl012mno345"

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

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

for d in deliveries:
    print(f"{d['event']} → {d['url']} — {d['status']} ({d['durationMs']}ms)")

Response

Status: 200 OK

The response body contains a data array of delivery log objects.

Fields

Each object in the array contains:

Field	Type	Description
id	string	Unique identifier for the delivery record.
userId	string	ID of the user who owns the webhook.
webhookId	string	ID of the webhook that was targeted.
extractionId	string	ID of the extraction that triggered this delivery.
event	string	Event name: extraction.completed or extraction.failed.
url	string	The webhook URL at the time of delivery.
status	string	success if the endpoint returned a 2xx status, failed otherwise.
httpStatus	number | null	HTTP response status code. null if the request failed before receiving a response (e.g. network error, timeout).
error	string | null	Error message if the delivery failed. null on success.
durationMs	number	Round-trip time of the delivery attempt in milliseconds.
createdAt	string	ISO 8601 timestamp of when the delivery was attempted.

Example

{
  "data": [
    {
      "id": "abc123def456",
      "userId": "uid_a1b2c3d4e5f6",
      "webhookId": "webhook-abc123def456",
      "extractionId": "extract-xyz789",
      "event": "extraction.completed",
      "url": "https://your-app.com/webhooks/docmap",
      "status": "success",
      "httpStatus": 200,
      "error": null,
      "durationMs": 342,
      "createdAt": "2025-01-20T14:30:04.000Z"
    },
    {
      "id": "def456ghi789",
      "userId": "uid_a1b2c3d4e5f6",
      "webhookId": "webhook-abc123def456",
      "extractionId": "extract-uvw456",
      "event": "extraction.failed",
      "url": "https://your-app.com/webhooks/docmap",
      "status": "failed",
      "httpStatus": null,
      "error": "The operation was aborted due to timeout",
      "durationMs": 10003,
      "createdAt": "2025-01-20T12:15:00.000Z"
    }
  ]
}

Errors

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