Standard Financial Statement Failure (standardFinancialStatementFailure)

Sent when a standard financial statement fails.

Id: standardFinancialStatementFailure

Event that notifies when a standard financial statement has failed.

Payload

These fields are sent in the payload object of the webhook envelope.

NameTypeDescription
reportIdstringThe unique id of the statement
failedAtstringThe time the statement failed (UTC, ISO 8601)
statusstringAlways failed for this event
externalUserIdstringThe identifier from your system supplied when the statement was requested. Absent when none was set

Example (JSON format)

{
  "id": "abe168ce-1b2f-4c38-9c92-db5730485cb3",
  "eventType": "standardFinancialStatementFailure",
  "userId": "5c79210bbac25ecb5e71ac40",
  "payload": {
    "reportId": "21403405-47d3-4da8-a56a-7e39c27d4395",
    "failedAt": "2024-07-30T15:08:01.000Z",
    "status": "failed",
    "externalUserId": "external-user-id"
  }
}

This example uses the JSON format. JWT webhooks carry the same payload fields in a different envelope, and batched webhooks list events without payloads. See Webhook Format.

Related