# Title Alert API

## Overview

The Title Alert API offers capabilities for a range of alerting services, including alerting of title notifications.

Using the Title Alert API service, customers can subscribe to VolumeFolio to receive alerts whenever there is a change or activity related to a nominated title. The following two types of alerts are sent to the customer (based on subscription):

- Dealings Alert (activity alert): Triggered when any change is made to the nominated title.
- Workspace Alert (LSS alert): Triggered when a workspace is opened with an ELNO, indicating preparation for a transaction involving the nominated title.


## Resources

| Endpoint | Description |
|  --- | --- |
| /health | Health Check Endpoint |
| /titles/subscriptions | Subscribe to a title alert |


## API URLs - Sandbox and Production

| Env | Base URL |
|  --- | --- |
| Mock* | A mocking service URL is available on the left pane under the API Reference. |
| DEV | https://dev.api.servictoria.com.au/vicland/alert/v1/ |
| UAT | https://test.api.servictoria.io/vicland/alert/v1/ |
| PROD | https://api.servictoria.io/vicland/alert/v1/ |


## Access Management

API consumers can follow this guideline to access the API:

[Authentication](/portal/rest/ddp-title-alert-api/docs/authentication)