Learn how to Integrate with Stripe within Maica
NDIS Notifications are data updates made available through webhooks for integrated systems when certain events occur within the NDIS. These notifications provide information on changes within the NDIS through webhooks, which Maica uses to capture and display event data. This data is then displayed or updated within the application as needed.
It is important to note that NDIS notifications via webhooks are not real-time alerts sent to users in the traditional sense. Instead, they function as data updates that are made available through webhooks when specific events occur on the NDIS side. These notifications simply provide information that Maica can retrieve and display to users, but they don't actively notify users on their own.
To further understand NDIS Notifications, please refer to the definitions from the NDIS:
| Term | Definition |
|---|---|
Please see the table below to see which NDIS Events Maica supports and handles.
The following table outlines the Events Maica supports.
Each Event is linked to an associated Flow Description. This explains in more detail how the Event is handled within Maica.
| Name | Code | Description |
|---|---|---|
In order to set up the NDIS Notifications within your Maica instance, please follow the following steps:
Create a Salesforce Site under the name NDIS Notifications.
To learn how to Create a Site, please click here.
Assign the Maica - Handle NDIS Notifications permission set to the Site Guest User.
This Permission Set grants access to Maica objects that will be updated based on the NDIS event payload.
Ensure the Site Guest User is assigned the proper timezone. This is important as Salesforce sets it to GMT by default.
Navigate to Maica Settings -> NDIS Notifications
Find and choose the created Site in the Notifications Endpoint (Site) , as shown below:
Finally, select the Subscribe All button
Please note, Maica’s subscription to NDIS events is secured with a private key generated on the Salesforce side, ensuring that only the authorised NDIS endpoint can transmit data to Maica’s Salesforce public site. Each notification payload is validated to confirm it is signed with the private key, maintaining the integrity and security of the data exchange.
NDIS Notifications
Digital Partners (Maica) can receive notifications for events they have subscribed to, by leveraging Webhooks.
Webhook
A webhook (also called a web callback or HTTP push API), is a lightweight API that powers one-way data sharing triggered by events. Unlike typical API's where you would need to poll for data in order to get updates in real-time, a webhook delivers data to your application as the event happens, meaning you get the data immediately.
Events
Specific actions or changes within the NDIS system that trigger data updates through webhooks. These events signify key occurrences related to a participant's plan, funding, or service interactions that integrated systems need to be aware of. Examples of events include a plan modification, a funding allocation update, or a change in the status of an invoice. When such an event occurs, the NDIS generates a webhook with the relevant data, allowing Maica to capture and reflect this information for users.
New Service Booking created
SB_NEW
The notification for this event will be triggered when a new service booking is created:
By a Staff member using the staff portal
By a Participant using the myplace participant portal
By a Provider using the myplace provider portal
Via API
SB End Date updated
SB_END_DATE_UPDATED
The notification for this event will be triggered when the end date of a service booking is updated:
By a Staff member using the staff portal
By a Participant using the myplace participant portal
By a Provider using the myplace provider portal
By a Digital Partner using Provider API's PATCH
Due to a plans' end date being updated as a result of an unscheduled plan review, participant access being revoked or participant access being ceased (due to death).
Service Booking Budget Updated
SB_BUDGET_UPDATED
The notification for this event will be triggered when the quantity and/or allocated amount of one or more supports within a service booking is updated:
By a Staff member using the staff portal
By a Participant using the participant portal
By a Provider using the myplace provider portal
Via API
Service Booking deleted
SB_DELETED
The notification for this event will be triggered when a service booking is deleted
By a Participant using the myplace participant portal
By a Provider using the myplace provider portal
By a Provider using the Provider API's DELETE /{service_booking_id} operation
Remittance Advise is generated
REMIT_ADV_GENERATED
The notification for this event will be triggered overnight and the JSON payload available in your chosen webhook, when the remittance advice is ready, for payment claims that have been processed and paid, the day before. See sample JSON payload below:
Please note that this notification does not currently work in the Test Vendor environment and therefore cannot be used for testing.
Budget Updated
BUDGET_UPDATED
This notification will allow Plan Managers and Support Coordinators to be notified when SAP participant's budget is changed given that consent is provided. The notification for this event will be triggered and sent to the Plan Manager or Support Coordinator when a participant's budget is updated, either via APIs or via a Staff Member using the Staff Portal, given that the provider has consent/authority with the related participant. The notification will be triggered for the following scenarios:
A participant plan extension
Service Booking creation, update, or deletion.
Service booking on quotation approved.
Update on Participant's Active Plan Budget.
Spent Amount
Remaining Amount (claim status is pending payment, or payment cancellation)
Plan End Date is updated
PLAN_END_DT_UPDATED
The notification of this event will be triggered when the plan end date of a participant's current active plan is updated
Due to an unscheduled plan review
Due to the auto extension of plan
Due to the participant's access ceasing (due to death for instance)
PACE Budget Updated
BUDGET_UPDATED
This notification will allow Plan Managers and Support Coordinator to be notified when a PACE participant's budget is updated.
The notification for this event will be triggered sent to the Plan Manager or Support Coordinator when a participant's budget is updated via APIs or a Staff Member using the Staff Portal given that provider has consent/authority with the related participant.
PACE New Plan Created
PLAN_APPROVED
This notification will allow Plan Managers or Support Coordinator to be notified when a participant's new plan is created.
The notification for this event will be triggered and sent to the Plan Manager or Support Coordinator when there is a new plan approval given that the provider has consent/authority to view plan details with the related participant.
PACE Relationship Created
RLTN_CREATED
For PACE participant the notification for this event will be triggered when:
My Provider Relationship is created between participant and provider in PACE.
Plan Manager Relationship is created between participant and provider in PACE.
Recovery Coach Relationship is created between participant and provider in PACE.
Support Coordinator Relationship is created between participant and provider in PACE.
PACE Relationship End Date Update
RLTN_END_DATE_UPDATE
For PACE participant the notification for this event will be triggered when:
My Provider Relationship end date is updated in PACE.
Plan Manager Relationship end date is updated in PACE.
Recovery Coach Relationship end date is updated in PACE.
Support Coordinator Relationship end date is updated in PACE.