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)

Partial Update Webhook

PATCH
/webhooks/{id}/
Partially update the details of a specific webhook. Note: The secret_key cannot be set via this endpoint.

Request

Path Params

Header Params

Body Params application/json

Example
{
    "is_active": false
}

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 PATCH 'https://api.financialreports.eu/webhooks//' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "is_active": false
}'

Responses

🟢200OK
application/json
Body

Example
{
    "id": 1,
    "url": "https://myapp.com/api/financialreports-webhook",
    "is_active": true,
    "include_markdown": false,
    "subscribed_filing_types": [
        "10-K",
        "Annual Report"
    ],
    "secret_key": "whk_sec_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6",
    "created_at": "2025-11-15T10:30:00Z",
    "updated_at": "2025-11-15T10:30:00Z"
}
Modified at 2025-11-15 06:49:38
Previous
Update Webhook
Next
Delete Webhook
Built with