Webhook Integration

Overview

Our webhook system enables real-time notifications when a new event occurred for the company you want. This allows you to instantly receive and process updates without having to repeatedly poll our API.

Event Types

Currently, we support the following events:

• clientview_updated - Triggered when a new ClientView model is generated for the company
• incremental_update - Triggered over any new group of data points published, either by analyst or autotagger
• series_updated - Triggered when fundamental data errors/changes are detected in the last 5 minutes

For all events, the webhook payload includes relevant data about the updates, with the specific structure varying by event type.

Setup Instructions

To set up a webhook, you need to provide the following information:

Request Format

When a webhook event is triggered, our system will send an HTTP POST request to your specified URL with the following:

Headers

Content-Type: application/json
{header_name}: {prefix} {auth_secret}

Example

• url: https://yoururl.com
• header_name: Authorization
• prefix: X-API-KEY
• auth_secret: secret_api_key

Webhook triggers a POST request to https://yoururl.com with the following headers:

Content-Type: application/json
Authorization: X-API-KEY secret_api_key

Body

Clientview Updated

{
  "event_type": "clientview_updated",
  "company_id": 2,
  "series": {
    "SERIES_ID_1": {
      "periods": [
        "2025Q1"
      ]
    },
    "SERIES_ID_2": {
      "periods": [
        "2025Q1"
      ]
    }
  }
}

Incremental Update

{
  "event_type": "incremental_update",
  "company_id": 2,
  "series": {
    "SERIES_ID_3": {
      "periods": [
        "2025Q1"
      ]
    },
    "SERIES_ID_4": {
      "periods": [
        "2025Q1"
      ]
    }
  }
}

Series Updated

{
  "event_type": "series_updated",
  "company_id": 2,
  "series": [
    {
      "id": 2,
      "type": "MERGING_ERROR",
      "period": "2024Q1",
      "run_date": "2024-06-02T12:00:00Z",
      "details": {
        "fundamental_id": 13,
        "series_id": 102,
        "field_changed": "series_id",
        "new_value": 102,
        "old_value": 103
      }
    },
    {
      "id": 3,
      "type": "TAGGING_ERROR",
      "period": "2024Q1",
      "run_date": "2024-06-03T12:00:00Z",
      "details": {
        "fundamental_id": 13,
        "series_id": 202,
        "field_changed": "fundamental_id",
        "new_value": 13,
        "old_value": 12
      }
    },
    {
      "id": 4,
      "type": "VALUE_ERROR",
      "period": "2024Q2",
      "run_date": "2024-06-04T12:00:00Z",
      "details": {
        "fundamental_id": 15,
        "series_id": 105,
        "field_changed": "fundamental_value",
        "new_value": 1500,
        "old_value": 1200
      }
    }
  ]
}

Series Updated Event Details:

The series_updated webhook is triggered every 5 minutes when fundamental data errors or corrections are detected. It includes:

• Supported Error Types: VALUE_ERROR, TAGGING_ERROR, MERGING_ERROR
• Frequency: Triggered every 5 minutes for companies with recent errors
• Payload Structure: Contains an array of error objects with detailed information about what changed
• Details Object: Includes the fundamental_id, series_id, field that changed, and both old and new values

This webhook provides granular notifications about data corrections, merges, tagging changes, and other meaningful updates to help you track data quality changes in real-time.

Need Help?

If you encounter any issues with webhook configuration or delivery, please contact your Sales Representative