---
title: "Test Webhook"
method: POST
path: "/webhooks/{id}/test/"
tags: ["Webhooks (Management)"]
---

# Test Webhook

`POST /webhooks/{id}/test/`

## Request

- Base URL: `https://api.financialreports.eu`
- URL: `https://api.financialreports.eu/webhooks/{id}/test/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Sends a pre-defined 'filing.processed.test' event to the configured webhook URL to verify its functionality. This creates a delivery record.

## Path parameters

- `id` integer, required

## Request body

- Webhook
  - `id` integer, required: The unique identifier for the webhook.
  - `url` string, uri, required: The endpoint URL (HTTPS required) to which the webhook payloads will be sent.
  - `is_active` boolean: Set to 'false' to temporarily disable this webhook without deleting it.
  - `include_markdown` boolean: Set to 'true' to include the full 'markdown_content' in the webhook payload. Set to 'false' to receive a payload without the markdown body.
  - `include_isins` boolean: Set to 'true' to include the list of ISINs in the company object. Warning: Large companies may have thousands of ISINs, increasing payload size.
  - `track_all_companies` boolean: Set to 'true' to subscribe to the Global Firehose. You will receive notifications for filings from ALL companies in the database, regardless of your Watchlist.
  - `trigger_on_filing_received` boolean: If true, triggers immediately when a filing is detected (Fastest). Note: Metadata like filing type may be null, and no markdown is included.
  - `trigger_on_filing_processed` boolean: If true, triggers when the filing has been fully analyzed and converted (Complete). Includes verified metadata and markdown content.
  - `trigger_on_filing_updated` boolean: If true, also sends 'filing.updated' when a filing you received is later re-typed or moved to another company, and 'filing.removed' when it is deleted, hidden or falls out of this webhook's scope, within 30 days of delivery. Not billed.
  - `deliver_late_filings` boolean: If true, also deliver filings that reached the platform more than 48 hours after publication, as long as they are at most 30 days late. These deliveries carry 'late': true. Off by default, because late arrivals are mostly backfills.
  - `subscribed_filing_types` string[]: A list of filing type codes (e.g., ['10-K', 'IR']) to subscribe to. If this list is empty or omitted, you will be subscribed to all filing types.
  - `created_at` string, date-time, required: Timestamp when the webhook was created.
  - `updated_at` string, date-time, required: Timestamp when the webhook was last updated.

## Response `200`

Test event was sent and the endpoint responded successfully.

- WebhookTestResponse: Result of POST .../test/ — same shape on success (200) and failure (400).
  - `status` string, required: Delivery status of the test event (e.g. 'success', 'failed').
  - `message` string, required: Human-readable description of the test outcome.
  - `delivery_uuid` string, uuid, required: UUID of the delivery record created for this test.

## Other responses

- `400`: Test event failed (e.g., endpoint returned an error, invalid URL).
- `403`: Missing or invalid API key, or the plan does not include this endpoint.
- `429`: Rate limit, plan quota or spend cap reached.

---

[API](https://skmtc.dev/financialreports/apis/financialfilings-api.md) · [All operations](https://skmtc.dev/financialreports/apis/financialfilings-api/llms.txt) · [OpenAPI document](https://skmtc.dev/financialreports/apis/financialfilings-api/revisions/55935bdabd20?raw)