Creating Registered Application

When developing integrations with external applications, it is essential to register these applications with eGain. This process allows external applications to receive and subscribe to events from eGain, enabling seamless integration and interaction. By registering applications, users can ensure that their systems can effectively communicate and interact with eGain, providing a robust framework for building customized solutions. 

The feature supports creating two new types of client applications for interacting with the eGain application:

The synchronous and asynchronous applications are not used to log into the eGain system.

• Synchronous Application: This type of application is used to subscribe to synchronous events from the eGain system in real-time, which are pushed to the Callback URL that is configured for the external application. This means the client app handles events immediately as they occur. You need to create custom rules in a workflow to subscribe to synchronous events. For more information, see Creating Custom Rules.
• Asynchronous Application: This type of application is used to subscribe to asynchronous events which are pushed to the Callback URL by the webhook services. The handling of these events can occur at a later time, allowing for more flexible processing since the client app does not need to handle the events immediately when they occur.

To create registered applications:

1. From the Navigation Menu, browse to Integration > External Apps > Registered Applications. 

2. In the Register Application page, click the New  button.
3. In the Create Register Application page, on the General tab, provide the following details: 

   1. Name: Provide a name for the client application.

   2. Application URL: This setting is not in use and is only enabled for ESC.

   3. Application Type: Select one of the following options: Synchronous or Asynchronous.

   4. Client Key: The client key is generated automatically upon successful creation. 

   5. Client Secret: This field is not applicable for synchronous and asynchronous applications.

   6. Description: Provide a suitable description to give additional context for the application. 

   

4. On the Callback URL tab, provide the following details: 

   1. Callback URL: Provide the Callback URL to which the webhook services send the events to.

   2. Callback Format: Select the JSON format.

   3. Callback Error Notification Email Address: The error notification is sent to the email address configured in this setting. The content of the error notification includes the name and description of the registered client, the callback URL, the error response received when calling the callback, the number of retries left, the next retry attempt time, and an indication if all retries have been exhausted.

   4. Authentication: From the dropdown, select the authentication that you have created for the application.

   

5. On the Subscriptions tab, select the events you want to subscribe to by checking the box next to each event. You can also manage the channels and view attributes related to the event by clicking the Edit button in the Actions column. The Subscriptions tab is only available for asynchronous applications. For synchronous applications, you need to create custom rules through the custom rules node in a workflow to subscribe to events.

   

6. Click Save.