---
title: "Create Webhook"
method: POST
path: "/webhooks/"
tags: ["Webhooks (Management)"]
---

# Create Webhook

`POST /webhooks/`

## Request

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

Create a new webhook subscription. The `secret_key` is returned in the response **only once**.

## 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 `201`

Webhook created. The `secret_key` is returned only in this response.

- WebhookCreateResponse: Response body for `create()` — identical to WebhookSerializer plus the one-time `secret_key`, which the view injects into the create response.
  - `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.
  - `secret_key` string, required: The webhook signing secret. Returned only once, in the create response.

## Other responses

- `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/a780251d6b05?raw)