APIs are great interfaces to integrate different applications. An API exposes the functionality and features to the external applications. Luma provides an inbound API that allows external applications to interact with users through Luma, which can be used for scenarios such as notifying users after completion of a service or request.
...
| Name | Value | Endpoint Example |
|---|---|---|
| Default URL | {{ENDPOINT}}/public/notifylumauser/message | https://lumastaging.serviceaide.com/vsa https://luma2.serviceaide.com/vsa https://luma3.serviceaide.com/vsa |
...
Authorization: Bearer {{API_TOKEN}}
Info title Note If the 'Bearer' text is not included, then 401 invalid token error response is received.
- Example API_TOKEN: Specify the alphanumeric access token available on Manage Tenant Information page.
- Content-Type: application/json
...
Status specifies the results of your request. For more details, see Status Codes.
Message specifies details of the status code.
...
If the request is a success with status code 200, then Luma notifies the users regarding the outage; else, Luma prompts the users to check the errors in the request and retry after fixing the errors.
If status code 400 is received, failure is recorded and available in Troubleshoot logs. This enables administrator to keep a check on the failed notification and rectify errors.
Trigger API Notification from a Luma Skill
...