Partial Update Webhook
Partially update the details of a specific webhook.
Request
- Base URL: https://api.financialreports.eu
- URL: https://api.financialreports.eu/webhooks/{id}/
- Auth: one of:
- API key in header X-API-Key
- HTTP bearer
Path parameters
A unique integer value identifying this webhook.
Request body
The unique identifier for the webhook.
The endpoint URL (HTTPS required) to which the webhook payloads will be sent.
Set to 'false' to temporarily disable this webhook without deleting it.
Set to 'true' to include the full 'markdown_content' in the webhook payload. Set to 'false' to receive a payload without the markdown body.
Set to 'true' to include the list of ISINs in the company object. Warning: Large companies may have thousands of ISINs, increasing payload size.
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.
If true, triggers immediately when a filing is detected (Fastest). Note: Metadata like filing type may be null, and no markdown is included.
If true, triggers when the filing has been fully analyzed and converted (Complete). Includes verified metadata and markdown content.
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.
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.
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.
Timestamp when the webhook was created.
Timestamp when the webhook was last updated.
Response
The unique identifier for the webhook.
The endpoint URL (HTTPS required) to which the webhook payloads will be sent.
Set to 'false' to temporarily disable this webhook without deleting it.
Set to 'true' to include the full 'markdown_content' in the webhook payload. Set to 'false' to receive a payload without the markdown body.
Set to 'true' to include the list of ISINs in the company object. Warning: Large companies may have thousands of ISINs, increasing payload size.
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.
If true, triggers immediately when a filing is detected (Fastest). Note: Metadata like filing type may be null, and no markdown is included.
If true, triggers when the filing has been fully analyzed and converted (Complete). Includes verified metadata and markdown content.
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.
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.
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.
Timestamp when the webhook was created.
Timestamp when the webhook was last updated.
Changes
No recorded changes to this operation across all 2 revisions of this API.