Skip to main content

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

  1. The User must be authenticated and have the Analyst role.
  2. The User has an external application can perform API calls towards the register that he wants to integrate.

Postconditions

  1. The SystemWebhook returnsis configured and the neededselected secrets/credentialsevents to be used to integratetrigger the external system.application.

Main flow

  1. The UserAnalyst triggersnavigates theto creationdjango ofadmin and configures a new external application integration (POST)Webhook.
  2. The SystemAnalyst generatesselects the neededURL secrets/credentialsof andthe returnsexternal themapplication to which the system will send notifications.
  3. The Analyst selects the type of events that should be sent to the user.external application.
  4. 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.