---
title: "Get Sample Payload for Webhook"
method: GET
path: "/api/v3/webhooks/{webhook_id}/sample-payload"
tags: ["Webhooks"]
---

# Get Sample Payload for Webhook

`GET /api/v3/webhooks/{webhook_id}/sample-payload`

## Request

- Base URL: `https://app.daloopa.com`
- URL: `https://app.daloopa.com/api/v3/webhooks/{webhook_id}/sample-payload`
- Auth: HTTP basic

Returns a sample payload matching the webhook's configured event type. The payload uses static example data and includes 'test': true. Fundamental events (clientview_updated, incremental_update, series_updated) carry a 'series' field; document_added carries a 'document' object instead. Only the webhook owner can access this endpoint.

## Path parameters

- `webhook_id` integer, required

## Response `200`

- object
  - `test` boolean
  - `event_type` string
  - `company_id` integer
  - `series` object: Present for fundamental events.
  - `document` object: Present for document_added events. Carries the document's raw filing_type and document_type exactly as returned by GET /documents (no normalization).

## Other responses

- `404`

## Changes

- **2026-11-03** `90ca7c9d6f4e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/daloopa/apis/daloopa-api/changes/api/v3/webhooks/:webhook_id/sample-payload/get.md)

---

[API](https://skmtc.dev/daloopa/apis/daloopa-api.md) - [All operations](https://skmtc.dev/daloopa/apis/daloopa-api/llms.txt) - [OpenAPI document](https://skmtc.dev/daloopa/apis/daloopa-api/revisions/90ca7c9d6f4e?raw)