> For the complete documentation index, see [llms.txt](https://docs.scaleconnect.com.au/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.scaleconnect.com.au/api/webhooks/events.md).

# Events

{% @scale-docs-page-title/page-title title="Events" %}

{% hint style="warning" %}
**Confirm before publishing:** which of these 20 proposed names ship in v1; align `loan.updated` and `loan.rate_expiring` with the broader event catalogue; freeze field types, optionality, consent filtering, payload version and links. The table is a proposed public subset, not evidence that these events are emitted today.
{% endhint %}

Subscribe to the event names that match the changes your integration handles. The common [envelope](/api/webhooks.md) carries `id`, `event`, `timestamp`, `source`, `actor` and an event-specific `data` object.

## Sync and import

| Event                     | When it is sent                         | Key `data` fields                                                                                                     |
| ------------------------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `client.created`          | A client is created from sync or import | `clientId`, `clientExternalId`, `strategyId`, `brokerEmail`, `crmSource`                                              |
| `client.updated`          | Stored client inputs change             | `clientId`, `clientExternalId`, `fieldsUpdated[]`                                                                     |
| `client.archived`         | A client leaves the linked broker book  | `clientId`, `clientExternalId`, `archivedAt`                                                                          |
| `client.linked_to_broker` | Broker attribution is established       | `clientId`, `clientExternalId`, `brokerEmail`, `brokerReference`                                                      |
| `property.created`        | A property is added                     | `clientExternalId`, `propertyId`, `propertyExternalId`, `address`, `ownership`                                        |
| `property.updated`        | Property inputs change                  | `clientExternalId`, `propertyId`, `propertyExternalId`, `fieldsUpdated[]`                                             |
| `loan.updated`            | Loan rate, balance or terms change      | `clientExternalId`, `propertyId`, `loanId`, `lenderLoanReference`, `currentRate`, `currentBalance`, `fieldsUpdated[]` |
| `sync.completed`          | A sync is processed                     | `clientId`, `clientExternalId`, `status`, `fieldsUpdated[]`, `modelRecalculated`                                      |
| `sync.rejected`           | A payload fails validation              | `clientExternalId`, `field`, `value`, `expectedRange`, `reason`                                                       |
| `import.completed`        | A bulk import finishes                  | `importId`, `created`, `updated`, `failed`                                                                            |
| `import.failed`           | A bulk import aborts                    | `importId`, `reason`, `processedBeforeFailure`                                                                        |
| `import.anomaly_detected` | An input is flagged                     | `clientExternalId`, `field`, `value`, `expectedRange`, `severity`                                                     |

## Triggers and workflows

| Event                            | When it is sent                      | Key `data` fields                                                                             |
| -------------------------------- | ------------------------------------ | --------------------------------------------------------------------------------------------- |
| `loan.rate_expiring`             | A fixed-rate expiry approaches       | `clientExternalId`, `loanId`, `expiryDate`, `daysUntilExpiry`                                 |
| `trigger.lvr_target`             | LVR crosses a configured threshold   | `clientExternalId`, `currentLvr`, `targetLvr`, `portfolioValue`, `totalDebt`                  |
| `trigger.equity_available`       | Available equity crosses a threshold | `clientExternalId`, `equityAvailable`, `threshold`                                            |
| `meeting.trigger_fired`          | A meeting rule becomes due           | `clientExternalId`, `triggerId`, `triggerType`, `dueDate`                                     |
| `review.requested`               | An AI review is requested            | `clientExternalId`, `reviewId`, `requestedBy`                                                 |
| `review.completed`               | An AI review finishes                | `clientExternalId`, `reviewId`, `reviewType`, `generatedAt`                                   |
| `report.strategy_ready`          | Strategy outputs are recomputed      | `clientId`, `clientExternalId`, `strategyId`, `recomputedAt`, `trigger`, `changed[]`, `links` |
| `report.portfolio_summary_ready` | Portfolio summary is recomputed      | `clientId`, `clientExternalId`, `recomputedAt`, `trigger`, `summary`, `links`                 |

The first three trigger events and `meeting.trigger_fired` depend on evaluators; they are not necessarily emitted by the mutation that changed an input. The two `report.*` events signal completed recomputation, not a downloadable document. Field-level examples and JSON Schema should be generated from the final event contract before publication.

## Handling changes

Use `fieldsUpdated[]` to decide whether to fetch a resource, not to reconstruct its current state. Do not treat event order as a version sequence. For a retry or replay, deduplicate on the envelope `id` and read the current resource if the downstream action depends on its latest value.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.scaleconnect.com.au/api/webhooks/events.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.