Create Webhook

POST

/webhooks/

Create a new webhook subscription. The secret_key will be generated and returned to you.

Request

Header Params

Body Params application/json

Example

{
    "url": "https://myapp.com/api/financialreports-webhook",
    "is_active": true,
    "include_markdown": false,
    "subscribed_filing_types": [
        "10-K",
        "Annual Report"
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.financialreports.eu/webhooks/' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "https://myapp.com/api/financialreports-webhook",
    "is_active": true,
    "include_markdown": false,
    "subscribed_filing_types": [
        "10-K",
        "Annual Report"
    ]
}'

Responses

🟢201Created

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

List Webhooks

Retrieve Webhook