FinancialReports
  1. Webhooks (Management)
FinancialReports
  • FinancialReports API Documentation
  • Changelog
  • Companies
    • List Companies
      GET
    • Retrieve Company Details
      GET
  • Filings
    • List Filings
      GET
    • Retrieve Filing Markdown
      GET
    • Retrieve Filing Details
      GET
  • Filing Types
    • The Financial Reporting Classification Framework (FRCF)
    • List Filing Types
      GET
    • Retrieve Filing Type
      GET
  • Languages
    • Understanding Language Codes
    • List Languages
      GET
    • Retrieve Language
      GET
  • ISIC Classifications
    • Understanding ISIC Classification
    • List ISIC Classes
      GET
    • Retrieve ISIC Class
      GET
    • List ISIC Divisions
      GET
    • Retrieve ISIC Division
      GET
    • List ISIC Groups
      GET
    • Retrieve ISIC Group
      GET
    • List ISIC Sections
      GET
    • Retrieve ISIC Section
      GET
  • Countries
    • Understanding Country Codes
    • List Countries
    • Retrieve Country
  • Sources
    • Understanding Data Sources
    • List Data Sources
    • Retrieve Data Source
  • Watchlist
    • Get User's Watchlist
    • Add Company to Watchlist
    • Remove Company from Watchlist
  • Webhooks (Management)
    • List Webhooks
      GET
    • Create Webhook
      POST
    • Retrieve Webhook
      GET
    • Update Webhook
      PUT
    • Partial Update Webhook
      PATCH
    • Delete Webhook
      DELETE
    • Regenerate Secret Key
      POST
    • Test Webhook
      POST
  1. Webhooks (Management)

Test Webhook

POST
/webhooks/{id}/test/
Sends a pre-defined 'filing.processed.test' event to the configured webhook URL to verify its functionality.

Request

Path Params

Header Params

Body Params application/json

Example
{
    "url": "http://example.com",
    "is_active": true,
    "include_markdown": true,
    "subscribed_filing_types": [
        "string"
    ]
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.financialreports.eu/webhooks//test/' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "http://example.com",
    "is_active": true,
    "include_markdown": true,
    "subscribed_filing_types": [
        "string"
    ]
}'

Responses

🟢200OK
application/json
Test event was sent and the endpoint responded successfully.
Body

Example
{}
🟠400Bad Request
🟠408408
Modified at 2025-11-15 06:49:38
Previous
Regenerate Secret Key
Built with