Skip to main content

Set recipients for failed API

At times, an API can fail when an external system calls it to interact with the eClinical system. Certain users need to be notified about the failed API. This helps them to acknowledge the matter so that they can take appropriate action. You can add certain users as recipients of the failed API, who are notified when the API fails.

To set the user as a recipient of failed API

  1. In the ADMIN application header, select the REPORT tab.

  2. On the page that opens, in the left pane, select External Gateway Logs.

  3. In the External Gateway Logs page that appears, from the toolbar, select Set recipients for failed API calls set_recipients_icon_.png.

  4. In the Set recipients for failed API calls dialog that appears, select the checkbox next to the user(s) or Select All to see the failed API recipients.

    Selecting users as recipients for failed API calls
    Figure 1. Selecting users as recipients for failed API calls

  5. Select save_button_red.png to save the implemented changes.

Once saved, the user or users are set as the recipients for failed API calls and are notified via mail when an API call fails.

In this section: