OAuth2 Authorization Code Flow

Authentication Configuration

When the OAuth2 Authorization Code Flow authentication type is selected on the Authorization type dropdown (4 from Figure 3 of this page), the options of Figure 30 will appear.

Figure 30 - Configuring an OAuth2 Authorization Code Flow AuthenticationFigure 30 - Configuring an OAuth2 Authorization Code Flow Authentication

Figure 30 - Configuring an OAuth2 Authorization Code Flow Authentication

Registering an App on an External System

To obtain the values of the fields, register your app on the external system. Each external system allows this to be achieved in different ways, so the corresponding documentation must be consulted.

Guidelines for Some of the Most Common CRMs that Use this Type of Authentication

All these systems include the creation of an OAuth Client to obtain this data. When doing so, it will be necessary to provide a redirect URL for Talkdesk®.

📘

Redirect URL

The redirect URL to be defined on the external system when creating the OAuth Client is, according to the account region:

Authorization Required Prompt

After filling all the required information from Figure 30, clicking Save (top right corner) will prompt a message indicating that an authorization is required, as depicted on Figure 31, providing you with two options.

Figure 31 - Authorization Required PromptFigure 31 - Authorization Required Prompt

Figure 31 - Authorization Required Prompt

By clicking the "Go to settings" button (1 - Figure 31) you will be redirected to the screens from Figures 33 and 34 (below), depending on the integration being successfully activated (Figure 33) or not (Figure 34).

Authorization Process

By clicking the Authorize button (2 - Figure 31), you will be redirected to a page of the external system, where you will be required to log in to the external system (if you are still logged out). This allows the connection between the two systems. If you were connecting to Zendesk, for instance, you would be prompted with the message from Figure 32 (after logging in).

Figure 32 - Zendesk authorization screenFigure 32 - Zendesk authorization screen

Figure 32 - Zendesk authorization screen

New Custom Integration

If the process goes well, you will now have a new custom integration (Figure 7 from this page).

Figure 33 depicts an example of how the custom integration settings are presented when checking the configurations of the new custom integration.

Figure 33 - Settings of a Custom Integration with the OAuth2 Authorization Code Flow AuthenticationFigure 33 - Settings of a Custom Integration with the OAuth2 Authorization Code Flow Authentication

Figure 33 - Settings of a Custom Integration with the OAuth2 Authorization Code Flow Authentication

🚧

The client ID and client secret are never displayed (Figure 33).

Authorization Process - Error

If an error occurs during the Authorization process, you will be immediately redirected to the Settings page, which will appear as shown in Figure 34.
To restart the authentication process, click the Reconfigure button, and it will take you back to the configuration page from Figure 30.

Figure 34 - Settings Page in Case of Authorization ErrorFigure 34 - Settings Page in Case of Authorization Error

Figure 34 - Settings Page in Case of Authorization Error


Did this page help you?