Webhooks (Management)

Test Webhook

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

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

Path parameters

idinteger required

A unique integer value identifying this webhook.

Request body

idinteger required

The unique identifier for the webhook.

urlstring uri required

The endpoint URL (HTTPS required) to which the webhook payloads will be sent.

is_activeboolean

Set to 'false' to temporarily disable this webhook without deleting it.

include_markdownboolean

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_isinsboolean

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_companiesboolean

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_receivedboolean

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_processedboolean

If true, triggers when the filing has been fully analyzed and converted (Complete). Includes verified metadata and markdown content.

trigger_on_filing_updatedboolean

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_filingsboolean

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_typesstring[]

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_atstring date-time required

Timestamp when the webhook was created.

updated_atstring date-time required

Timestamp when the webhook was last updated.

Response

Test event was sent and the endpoint responded successfully.

statusstring required

Delivery status of the test event (e.g. 'success', 'failed').

messagestring required

Human-readable description of the test outcome.

delivery_uuidstring uuid required

UUID of the delivery record created for this test.

Changes

No recorded changes to this operation across all 2 revisions of this API.