Search documentation
karat

+

K

API Reference ↗

Registering third-party applications

Before a third-party application can be connected to Gotham, it must be registered on the platform.

The initial registration process creates a name, a client ID, and a client secret for the third-party application; see the OAuth.com docs for more information on client IDs and client secrets, which are used in the authorization workflow.

Then, a third-party application will need to be configured with a redirect URL for the authorization process, as well as a name, description, and icon which are used for the in-platform representation of the third-party application.

Registration

  1. To begin the process of registering a new application, navigate to the Third-party applications tab, select the All applications tab, and click Register new application.
  2. This will open the Register new application modal window. Here, you can name your application and choose the client type. Select Create to continue or Cancel to close the window.
  3. You will see an on-screen confirmation that your application has been registered. You will need to enable the application for your organization in order to use the application. The confirmation screen also displays the client ID and the client secret. Record the client ID and client secret as you will not be able to view the client secret again after leaving this screen.
Warning

If using a confidential client, you must copy the client secret at this point. The secret will not be available again after leaving this page. If you lose access to the client secret, you will need to rotate the secret.

  1. Select Done to continue to the Manage application interface.
  2. After reviewing the application details in the Manage application interface, select Save to complete the registration process.