4.62. Analyst - Integrate external applications
| Id | 4.62. |
| Description |
As an Analyst,
I must be able to integrate external application with the register,
So that I can access the data from within these applications in order to perform advance analytics (e.g. Tableau). |
| Priority | High |
| Actors | Analyst |
| API Calls | Not done via API. Webhooks are configured via the Django Administration panel. |
| Linked Processes | |
| Status | Implemented |
Preconditions
- The User must be authenticated and have the Analyst role.
- The User has an external application
can perform API calls towards the registerthat he wants to integrate.
Postconditions
- The
SystemWebhookreturnsis configured and theneededselectedsecrets/credentialseventsto be used to integratetrigger the externalsystem.application.
Main flow
- The
UserAnalysttriggersnavigatesthetocreationdjangoofadmin and configures a newexternal application integration (POST)Webhook. - The
SystemAnalystgeneratesselects theneededURLsecrets/credentialsofandthereturnsexternalthemapplication to which the system will send notifications. - The Analyst selects the type of events that should be sent to the
user.external application. - The Analyst configures the authentication method and saves.
Exceptions
[400 Bad Request] Invalid input:
If mandatory fields are missing or invalid, the system returns an error message.
[500 Internal Server Error] System Error
If the system fails to save changes due to an internal error, it displays an appropriate message and logs the error for further investigation.