External integrations with Cornerstone Saba

Cornerstone Saba allows building your integrations by making external API calls using OAuth 2.0 authentication. These integrations can then be used in Webhook actions which are called whenever an event occurs.

External Integrations option is available under System > Manage Integrations. On this page, you can manage all your external Cornerstone Saba integrations and configure the outgoing API connections of type OAuth 2.0.

Figure 1. External Integrations
Manage external integrations with Cornerstone Saba

This page lists the existing integrations that you have configured.

To add a new external integration:
  1. As a system administrator, navigate to System > Manage Integrations > External Integrations.
  2. Click New External Integration. The Create new External Integration page opens.
    Figure 2. Adding a new External Integration
    Manage external integrations with Cornerstone Saba
  3. In the Create new External Integration page, enter the following details:
    • Name: Provide a new to identify the integration implemented. This can be any name you choose.
    • Description: Provide a useful description of the integration that you're adding.
    • Status: You can mark an integration as Active or Inactive.
    • Authentication: Enter the authentication details in this section. These are the details provided by your vendor or the development partner in order to authenticate the request from Cornerstone Saba. Under this section, provide the API details such as the method type (GET, POST or PUT), the Client ID, Client Secret, Scope, Access Token URL and also indicate whether the credentials should be sent as part of the Body or the basic authentication header under the Client Authentication field.
    • Request Headers: You can enter a maximum of 5 request headers.

  4. After you've added the integration, click Verify Authentication to validate the authentication details you've entered.

  5. Click Save.
To update an already existing external integration:
  1. As a system administrator, navigate to System > Manage Integrations > External Integrations.
  2. Click the Edit action icon for the appropriate external integration.
To mark an External Integration as active or inactive:
  1. As a system administrator, navigate to System > Manage Integrations > External Integrations.
  2. Click the Mark Active or Mark Inactive action icons for the appropriate external integration.
    Figure 3. Mark an External Integration active or inactive
    Mark an External Integration active or inactive
To associate a Webhook template with an External Integration:
  1. As a system administrator, click System > Manage Integrations > Webhook Notification Template.
  2. Click Add Template to add a new template or edit an already existing template. The Webhook Template page appears.
  3. Provide the appropriate information in the fields.
  4. Select an existing External Integration to associate with this Webhook template using the External Integration for Authorization drop-down. After you select an External Integration, a header called "Authorization" is automatically added. You cannot delete the "Authorization" header.
    Note: If the Webhook template already has a header called "Authorization", you will need to remove it, prior to associating an External Integration.

    If you select an inactive External Integration, the actual API calls will fail.

    Figure 4. Associate an External Integration for Authorization
    External Integration for Authorization
    You cannot add a header with the key name "Authorization" for any Webhook template having an External Integration associated with it.
    Note: Currently the related details of an External Integration cannot be Exported or Imported using the Import/Export feature.
  5. After you've associated the Webhook template with an External Integration, you can then use that template from the Manage Notifications > Events > Notification Event Details > Event Action Details page for Webhook type event actions or alternatively from the System > Configure System > Services > <Service Name> > Notifications tab > <Event Name> > <Event Action Name> > Event Action Details page.
    Figure 5. Using the Webhook template associated with an External Integration
    Using the Webhook template associated with an External Integration