First Leeward

Webhook event

Statement Status Updated

POSTSTATEMENT_STATUS_UPDATED

Fired when a requested statement finishes: GENERATED when its file is ready to download via GET /statements/{id}/download, or FAILED when it could not be produced.

Body

application/json

idstringrequired

Unique event identifier for idempotency

typestringrequired

Webhook event type

Available options:STATEMENT_STATUS_UPDATED
dataobjectrequired
Show child attributes
idstring<uuid>required

Unique statement identifier

typestringrequired

What the statement itemises

Available options:CARD_TRANSACTION_FEESCARD_NON_TRANSACTION_FEES
originstringrequired

Who requested the statement

Available options:CLIENTFIRST_LEEWARD
statusstringrequired

Current statement status

Available options:PENDINGGENERATEDFAILED
periodobjectrequired
Show child attributes
fromstring<date>required

First calendar day covered, inclusive, UTC

tostring<date>required

Last calendar day covered, inclusive, UTC

fieldsstring[] | nullrequired

Columns in the file, in order. null means every column of the type.

formatstringrequired

File format

Available options:CSV
versionstringrequired

API version the statement was requested under. Fixes the column definitions the file follows.

rowCountinteger | nullrequired

Number of data rows in the file, once generated

byteSizeinteger | nullrequired

Size of the file in bytes, once generated

dataAsOfstring | nullrequired

ISO 8601 timestamp of how fresh the source data was when the file was produced, when known

generatedAtstring | nullrequired

ISO 8601 timestamp of when the file became available

createdAtstringrequired

ISO 8601 timestamp of creation

updatedAtstringrequired

ISO 8601 timestamp of last update

Response

200Webhook received successfully. Return any 2xx status to acknowledge.