Getting Updates

WebhooksCopied!

It is recommended to use webhooks for getting updates on events. The list of available webhooks are:

companyCreated
eventCreated
eventDeleted
dateChanged
audioAdded
transcriptAdded
slidesAdded
reportAdded
liveCallUrlChanged
willBeLive
liveStarted
liveFinished
liveFailed
liveTranscriptStarted
documentCreated

Managing Webhook Subscriptions

You can manage webhook subscriptions through the Quartr API or through the Quartr API Portal by registering, unregistering, and listing your subscriptions.

Pick the events you want to get notified about and register a webhook. You can choose to register events for all the companies in coverage or for specific companies. If you wish to register a webhook subscription only for specific companies, you can pass in a list of company IDs, tickers, and/or ISIN codes in the body of a request in the following format:

curl -X 'POST' \
  'https://api.quartr.com/public/v1/webhooks/register?subscriptionType=eventCreated&targetUrl=yourTargetUrl' \
  -H 'accept: application/json' \
  -H 'x-api-key: your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
  "tickers": [
    {
      "country": "US",
      "ticker": "AAPL"
    }
  ],
  "companyIds": [
    3706
  ],
  "isins": [
    "US0003041053"
  ]
}'

Note: Not specifying a list subscribes to all companies.

Once a specified event happens, we will send a request to the targetUrl you’ve specified with a payload.

Receiving Endpoint Requirements

To ensure proper handling of webhook notifications, your receiving endpoint should meet the following requirements:

Use HTTPS: Your endpoint must be secured with HTTPS to ensure the data transmitted is encrypted and secure.
Acknowledge receipt: Your endpoint should respond with an HTTP status code in the 2xx range to acknowledge receipt of the notification. Failure to acknowledge receipt may result in retries from the Quartr API.
Handle retries: The Quartr API may retry sending notifications if your endpoint does not acknowledge receipt or if it encounters an error. Be prepared to handle retries and deduplicate events based on their unique identifiers.
Webhook notifications contain event data in the request body, so ensure your receiving endpoint can parse and handle the data appropriately.

Listing webhook subscriptions

To list your webhook subscriptions, make a request to the Get Webhook Subscriptions endpoint.

GET https://api.quartr.com/public/v1/webhooks/subscriptions

Webhook PayloadsCopied!

The body of the received webhooks will vary slightly depending on whether it relates to a company, event, a live event.

Hooks may be triggered from multiple previous states. Eg, a “liveStarted” hook may be sent out on an event previously marked as “willBeLive” but it may have skipped that state. Use the field previousProperties in comparison to the current data to see the data transition that has taken place.

Company

companyCreated payload

{
  "name": "companyCreated",
  "uuid": "1b6b53dd-79d7-4fee-a7dd-f7420b5e5053",
  "data": {
    "companyId": 9999,
    "data": {
      "companyName": "Mock Company Inc",
      "companyCountry": "Mock Country",
      "companyTicker": "MCK",
      "companyWebsiteUrl": "https://www.mockcompanywebsite.com",
      "displayName": "Mock Company"
    },
    "company": {
      "companyName": "Mock Company Inc",
      "companyCountry": "Mock Country",
      "companyTicker": "MCK",
      "companyWebsiteUrl": "https://www.mockcompanywebsite.com",
      "displayName": "Mock Company"
    }
  }
}

Event

{
  "name": "eventCreated",
  "uuid": "677dc8a9-7570-4509-986f-bec140de8ddc",
  "data": {
    "companyId": 9999,
    "event": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "transcripts": {
        "transcriptUrl": null
      }
    },
    "data": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "transcripts": {
        "transcriptUrl": null
    },
    "previousProperties": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "transcripts": {
        "transcriptUrl": null
    }
  }
}

{
  "name": "eventDeleted",
  "uuid": "9f2d12b8-6694-4f77-9a82-334dd38bf0ec",
  "data": {
    "companyId": 9999,
    "event": null,
    "data": null,
    "previousProperties": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "transcripts": {
        "transcriptUrl": null
    }
  }
}

{
  "name": "dateChanged",
  "uuid": "70cbbe87-6741-4f77-b319-a019a74d453c",
  "data": {
    "companyId": 9999,
    "event": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "transcripts": {
        "transcriptUrl": null
    },
    "data": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "transcripts": {
        "transcriptUrl": null
    },
    "previousProperties": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "transcripts": {
        "transcriptUrl": null
    }
  }
}

{
  "name": "audioAdded",
  "uuid": "d278b215-4125-4f14-9b58-109a8a9af7ce",
  "data": {
    "companyId": 9999,
    "event": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "transcripts": {
        "transcriptUrl": null
    },
    "data": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "transcripts": {
        "transcriptUrl": null
    },
    "previousProperties": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "transcripts": {
        "transcriptUrl": null
    }
  }
}

{
  "name": "transcriptAdded",
  "uuid": "07c2268c-4d49-46e8-96b8-e5ad01251349",
  "data": {
    "companyId": 9999,
    "event": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "transcripts": {
        "transcriptUrl": null
    },
    "data": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "transcripts": {
        "transcriptUrl": null
    },
    "previousProperties": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "transcripts": {
        "transcriptUrl": null,
    }
  }
}

{
  "name": "slidesAdded",
  "uuid": "0b214353-7ca6-477f-880b-f63a06478ccf",
  "data": {
    "companyId": 9999,
    "event": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "transcripts": {
        "transcriptUrl": null
    },
    "data": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "transcripts": {
        "transcriptUrl": null
    },
    "previousProperties": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "transcripts": {
        "transcriptUrl": null
    }
  }
}

{
  "name": "reportAdded",
  "uuid": "1ff88007-724a-436d-9cf4-e8ee0c96cc52",
  "data": {
    "companyId": 9999,
    "event": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "backlinkUrl": "https://quartr.com/"
    },
    "data": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "backlinkUrl": "https://quartr.com/"
    },
    "previousProperties": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "backlinkUrl": "https://quartr.com/"
    }
  }
}

Live Events

Webhooks regarding live events includes the liveState of the event.

Live events can be unpredictable for many reasons, like connectivity issues, manual restarts on the company/provider end, and unplanned events that we establish a connection with right as its starting, to name a few. For this reason these web hooks are not guaranteed to be sent in a specific order.

{
  "name": "liveCallUrlChanged",
  "uuid": "28260978-ab09-4fbd-98b9-ad51cec86474",
  "data": {
    "companyId": 9999,
    "event": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "liveState": {
        "liveAudioState": "will_be_live",
        "liveUrl": "https://quartr.com/",
        "wentLiveAt": null
      },
      "transcripts": {
        "transcriptUrl": null
      }
    },
    "data": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "liveState": {
        "liveAudioState": "will_be_live",
        "liveUrl": "https://quartr.com/",
        "wentLiveAt": null
      },
      "transcripts": {
        "transcriptUrl": null
      }
    },
    "previousProperties": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "liveState": {
        "liveAudioState": "will_be_live",
        "liveUrl": "https://quartr.se/",
        "wentLiveAt": null
      },
      "transcripts": {
        "transcriptUrl": null
      }
    }
  }
}

{
  "name": "willBeLive",
  "uuid": "c30d266a-1ae7-4dca-848b-12c48d162233",
  "data": {
    "companyId": 9999,
    "event": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "liveState": {
        "liveAudioState": "will_be_live",
        "liveUrl": "https://quartr.com/",
        "wentLiveAt": null
      },
      "transcripts": {
        "transcriptUrl": null
      }
    },
    "data": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "liveState": {
        "liveAudioState": "will_be_live",
        "liveUrl": "https://quartr.com/",
        "wentLiveAt": null
      },
      "transcripts": {
        "transcriptUrl": null
      }
    },
    "previousProperties": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "liveState": {
        "liveAudioState": "not_live",
        "liveUrl": "https://quartr.com/",
        "wentLiveAt": null
      },
      "transcripts": {
        "transcriptUrl": null
      }
    }
  }
}

{
  "name": "liveStarted",
  "uuid": "9c8e8519-5e29-4061-9130-5be982883e95",
  "data": {
    "companyId": 9999,
    "event": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "liveState": {
        "liveAudioState": "live_started",
        "liveUrl": "https://quartr.com/",
        "wentLiveAt": null
      },
      "transcripts": {
        "transcriptUrl": null
      }
    },
    "data": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "liveState": {
        "liveAudioState": "live_started",
        "liveUrl": "https://quartr.com/",
        "wentLiveAt": null
      },
      "transcripts": {
        "transcriptUrl": null
      }
    },
    "previousProperties": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "liveState": {
        "liveAudioState": "will_be_live",
        "liveUrl": "https://quartr.com/",
        "wentLiveAt": null
      },
      "transcripts": {
        "transcriptUrl": null
      }
    }
  }
}

{
  "name": "liveFailed",
  "uuid": "9c8e8519-5e29-4061-9130-5be982883e95",
  "data": {
    "companyId": 9999,
    "event": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "liveState": {
        "liveAudioState": "live_failed_interrupted",
        "liveUrl": "https://quartr.com/",
        "wentLiveAt": "2024-04-03T18:20:18.179Z"
      },
      "transcripts": {
        "transcriptUrl": null
      }
    },
    "data": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "liveState": {
        "liveAudioState": "live_failed_interrupted",
        "liveUrl": "https://quartr.com/",
        "wentLiveAt": "2024-04-03T18:20:18.179Z"
      },
      "transcripts": {
        "transcriptUrl": null
      }
    },
    "previousProperties": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": {},
      "liveState": {
        "liveAudioState": "live_started",
        "liveUrl": "https://quartr.com/",
        "wentLiveAt": "2024-04-03T18:20:18.179Z"
      },
      "transcripts": {
        "transcriptUrl": null
      }
    }
  }
}

{
  "name": "liveTranscriptStarted",
  "uuid": "46b80491-8329-4947-be08-7d637cccdc3e",
  "data": {
    "companyId": 11443,
    "event": {
      "eventId": 205245,
      "eventTitle": "Investor Update",
      "eventDate": "2024-06-24T19:00:00.000Z",
      "companyId": 11443,
      "qnaTimestamp": null,
      "fiscalPeriod": null,
      "fiscalYear": null,
      "eventType": {
        "type": "Investor Update",
        "secondaryType": "Update / Briefing"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://app.quartr.com/document/205245/transcript",
      "transcriptViewerUrl": "https://app.quartr.com/document/205245/transcript",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": "2024-06-24T19:05:06.000Z"
      },
      "backlinkUrl": {},
      "liveState": {
        "liveAudioState": "live_transcript_started",
        "liveUrl": "https://quartr.com",
        "wentLiveAt": "2024-06-20T12:00:00.000Z"
      },
      "liveTranscripts": {
        "liveTranscriptUrl": "https://quartr.com",
        "finishedLiveTranscriptUrl": "https://quartr.com"
      },
      "transcripts": {
        "transcriptUrl": "https://quartr.com"
      }
    },
    "data": {
      "eventId": 205245,
      "eventTitle": "Investor Update",
      "eventDate": "2024-06-24T19:00:00.000Z",
      "companyId": 11443,
      "qnaTimestamp": null,
      "fiscalPeriod": null,
      "fiscalYear": null,
      "eventType": {
        "type": "Investor Update",
        "secondaryType": "Update / Briefing"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://app.quartr.com/document/205245/transcript",
      "transcriptViewerUrl": "https://app.quartr.com/document/205245/transcript",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": "2024-06-24T19:05:06.000Z"
      },
      "backlinkUrl": {},
      "liveState": {
        "liveAudioState": "live_transcript_started",
        "liveUrl": "https://quartr.com",
        "wentLiveAt": "2024-06-20T12:00:00.000Z"
      },
      "liveTranscripts": {
        "liveTranscriptUrl": "https://quartr.com",
        "finishedLiveTranscriptUrl": "https://quartr.com"
      },
      "transcripts": {
        "transcriptUrl": "https://quartr.com"
      }
    }
  }
}

{
  "name": "liveFinished",
  "uuid": "9c8e8519-5e29-4061-9130-5be982883e95",
  "data": {
    "companyId": 9999,
    "event": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": "https://quartr.com/",
      "liveState": {
        "liveAudioState": "processing_recording",
        "liveUrl": "https://quartr.com/",
        "wentLiveAt": "2024-04-03T18:20:18.179Z"
      },
      "transcripts": {
        "transcriptUrl": null
      }
    },
    "data": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
            "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": "https://quartr.com/",
      "liveState": {
        "liveAudioState": "processing_recording",
        "liveUrl": "https://quartr.com/",
        "wentLiveAt": "2024-04-03T18:20:18.179Z"
      },
      "transcripts": {
        "transcriptUrl": null
      }
    },
    "previousProperties": {
      "eventId": 1234,
      "eventTitle": "Mock Event Q1 2024",
      "eventDate": "2024-01-01T00:00:00.000Z",
      "companyId": 9999,
      "qnaTimestamp": null,
      "fiscalPeriod": "Q1",
      "fiscalYear": "2024",
      "eventType": {
        "type": "Q1",
        "secondaryType": "Mock Earnings Call"
      },
      "audioDuration": null,
      "slidesPreviewUrl": null,
      "audioUrl": null,
      "pdfUrl": null,
      "slidesUrl": null,
      "reportUrl": null,
      "transcriptUrl": "https://quartr.com/",
      "transcriptViewerUrl": "https://quartr.com/",
      "documentsLastUpdated": {
        "pdf": null,
        "report": null,
        "transcript": null
      },
      "backlinkUrl": "https://quartr.com/",
      "liveState": {
        "liveAudioState": "live_started",
        "liveUrl": "https://quartr.com/",
        "wentLiveAt": "2024-04-03T18:20:18.179Z"
      },
      "transcripts": {
        "transcriptUrl": null
      }
    }
  }
}

Documents

In our effort to support more document types, the document entity has been moved to its own domain. Rather than only including the different documents under proprietary names in the event webhooks, these are now also being sent out separately.

Note that subscribing to both document specific event webhooks (transcriptAdded, slidesAdded, reportAdded) and document webhooks (documentCreated), will in some cases lead to duplicated webhooks being received.

{
  "name": "documentCreated",
  "uuid": "a42f5ca9-04dd-42a4-af0f-78356f194a8f",
  "data": {
    "companyId": 17700,
    "data": {
      "id": 420319,
      "name": "Mobimo Holding AG - H1 2024 - Report",
      "typeId": 6,
      "eventId": 222845,
      "documentUrl": "https://quartr.com/",
      "updatedAt": "2024-08-19T14:40:30.000Z",
      "companyId": 17700
    }
  }
}

Webhook Signature Verification using HMACCopied!

To ensure the integrity and authenticity of the data being sent to your endpoints, our API uses HMAC (Hash-based Message Authentication Code) signing for webhook signature verification. This process helps verify that the payload sent by our servers has not been tampered with and that it indeed originates from us.

How It Works

Secret Key: When you configure your webhook endpoint in our portal, you will be presented with the ability to set a key that will be used for signing the webhooks.
Payload: The data sent to your webhook endpoint, more specifically, the body of the request received by our servers.
Signature: The signature is a hash generated using the HMAC algorithm with the SHA-256 hash function, combining the payload and the secret key.

Verifying the Signature

To verify the signature on your server, follow these steps:

Extract the signature: Retrieve the signature from the X-Quartr-Signature header of the incoming request.
Compute the HMAC hash: Using the same secret key and the payload received in the request, compute the HMAC-SHA256 hash.
Compare signatures: Compare the signature from the header with the computed hash. If they match, the payload is verified.

Security Considerations

While HMAC signing significantly enhances the security and integrity of the data exchanged via webhooks, it is not a replacement for adhering to good security standards and practices. Instead, it should be part of a broader strategy to protect your systems and data. Also, make sure to rotate your keys regularly.