Standard Financial Statement Success (standardFinancialStatementSuccess)

Sent when a standard financial statement completes successfully.

Id: standardFinancialStatementSuccess

Event that notifies when a standard financial statement has been completed. Retrieve the statement with the get standard financial statement endpoint.

Payload

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

Name	Type	Description
reportId	string	The unique id of the statement
createdAt	string	The time the statement was created (UTC, ISO 8601)
status	string	Always `complete` for this event
externalUserId	string	The 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": "standardFinancialStatementSuccess",
  "userId": "5c79210bbac25ecb5e71ac40",
  "payload": {
    "reportId": "21403405-47d3-4da8-a56a-7e39c27d4395",
    "createdAt": "2024-07-30T15:08:01.000Z",
    "status": "complete",
    "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.

Standard Financial Statement Failure

Updated about 6 hours ago

Payload

Example (JSON format)

Related