toolkit-monitoring-report.draft generated
Occurs whenever a draft monitoring report is generated. This can happen via the Monitoring Report tab within a Client or via the Batch Reporting module.
toolkit-monitoring-report.clientreadygenerated
Occurs whenever a client ready monitoring report is generated. This can happen via the Monitoring Report tab within a Client or via the Batch Reporting module.
toolkit-monitoring-report.completed
Occurs whenever a monitoring report is marked as completed. This can happen via the Monitoring Report tab within a Client or via the Batch Reporting module.
toolkit-monitoring-report.reproduce
Occurs whenever a monitoring report is returned to a draft state. This can happen via the Monitoring Report tab within a Client or via the Batch Reporting module.
All four events utilize the same Monitoring Report Object.
Timestamp date
Data the report was generated.
Source enum
Possible values are Batch Report, Client UI.
UserId Guid
Unique identifier of the user that ran this report.
UserFirstLastName String
First and last name of the user that ran this report.
WorkspaceId int
Id of the workspace the monitoring report exists in.
WorkspaceName String
Name of the workspace the monitoring report exists in.
ClientBookId int
Unique identifier for the client book this client exists in.
ClientBookName String
Name of the client book this client exists in.
ClientId int
Unique identifier for the client.
ExternalClientId nullable String
This is commonly a unique identifier for the Client from an external system which you want to integrate with.
ClientName String
Name of the client.
ClientEmails nullable String
Comma separated list of the emails that are associated with the client. Can be one or many,
PolicyName String
Name of the investment policy within the client for which this monitoring report is linked to.
Accounts Dictionary
List of accounts included within this monitoring report. Most commonly this is just one.
Child Attributes for each account;
AccountName String
Name of the account.
NumberOfParticipants nullable int
Number of participants within this account.
NumberOfFunds int
The number of fund holdings within this account.
TotalAccountBalance decimal
The total account balance across all the fund holdings in the account.
ProviderName nullable String
The name of the integration provider which is linked to this account.
ProviderNumber nullable String
The unique identifier for the account at the linked integration provider.
Investments Dictionary
List of investments included within this account.
Child Attributes for each Investment;
[
Secid nullable String
The name of the integration provider which is linked to this account.
InvestmentName String
The name of the integration provider which is linked to this account.
Ticker nullable String
The name of the integration provider which is linked to this account.
PeerGroup Enum
Possible values include every Morningstar Category (See other reference article for the full list)
Fi360AvgScore1Year nullable String
The Fi360 Fiduciary Score 1yr Rolling Average as of the monitoring period this report was run for.
Fi360AvgScore3Year nullable String
The Fi360 Fiduciary Score 3yr Rolling Average as of the monitoring period this report was run for.
Fi360AvgScore5Year nullable String
The Fi360 Fiduciary Score 5yr Rolling Average as of the monitoring period this report was run for.
Fi360AvgScore10Year nullable String
The Fi360 Fiduciary Score 10yr Rolling Average as of the monitoring period this report was run for.
Fi360Score nullable String
The Fi360 Fiduciary Score as of the monitoring period this report was run for.
Action Enum
Possible values include Watch, Remove, Proposed, None.
Type String
Possible values include Active, Passive, Target Date Investment and Money Market/Stable Value.
Assets Decimal
The assets for the particular investment.
]
MonitoringPeriod String
The quarter this monitoring report was run for. Stated as QQ YYY such as Q3 2023.
ReportTemplateName nullable String
The name of the report template that was used to generate this report. Will be NULL for the reproduce event as no report is generated.
EndpointWorkspaceGuid Guid
Unique identifier of the workspace that the webhook event was created on. Will not be provided for the reproduce event as no report is generated.
URL String
Path that can be used to download a PDF copy of the report. For security reasons, this URL needs combined with the EndpointWorkspaceGuid to create the full path to the file as shown below. Also, once downloaded, the PDF cannot be re-downloaded via the same path.
Full Path to PDF: URL&ws=EndpointWorkspaceGuid
Will not be provided for the reproduce event as no report is generated.