Webhooks (Early Adopter) - Overview

Webhooks is an HTTP-enabled feature that enables customers to create a deeper integration into the Cornerstone ecosystem by enabling near real-time access to critical business event data. With Webhooks, you can direct your Cornerstone CSX portal to automatically communicate the occurrence of specific events (such as, a training completion) to the other systems on which your organization relies.

Starter Guide

Click here to download the Webhooks Starter Guide.

Why use Webhooks?

Webhooks provides the following:

  • Event-driven notifications to drive more timely business process execution
  • Full event data payloads that do not require multiple API calls
  • Asynchronous processing of data
  • Decreased implementation complexity

Customers implementing Webhooks will see the following:

  • Easier integrations that yield lower TTFHW (Time to First Hello World), which is an important metric for data integrations
  • Fewer polling API calls to receive critical data faster
  • Improved data quality yielding fewer data-fix and no-fix defects

Compared to current API functionality, customers should see a reduced need to call throttled APIs such as the Reporting API, Employee API, and Training API as they adopt the corresponding Webhooks. Webhooks can be used to supplement existing API calls for Employee, Transcript, and Training information to shorten the time to receive notifications on changes to any of this information. Note: Employee and Transcript event Webhooks will be available in a later release. Only Training Assignment/Completion and Status monitoring events are available in the Early Adopter release.

Data Throughput of Webhooks

Data throughput of webhooks is dependent upon endpoint call response time and the infrastructure tiering of the webhook:

  • Tier 1: 300 records per minute

Note: In the Early Adopter release, all webhooks are built with Tier 1 infrastructure. Further information will be provided about infrastructure tiering prior to the GA (General Availability) release.

Early Adopter Webhooks Key Features

Customers can create, stop, and start webhooks for easy consumption of Cornerstone business event data. Customers can subscribe to Status webhooks to automate organizational alerts. An action audit log is being captured for Cornerstone's support team to ensure compliance and change tracking. However, the audit log will not be exposed via the user interface until a future release.

Future Enhancements

Future enhancements may include the following:

  • Ability to establish notifications based on a Status webhook
  • Support of infrastructure tiering to support business process requirements
  • Addition of filtering to control the output of webhooks payloads
  • Projection of webhook payloads to reduce amount of data in a payload

Resources

Implementation

Webhooks can be enabled for all customers except for customers on swimlanes SL4.

To enable Webhooks in Stage environments, contact Global Customer Support.

To enable Webhooks in Production environments, contact your account executive to purchase Webhooks. Once purchased, contact Global Customer Support to enable Webhooks.

When Webhooks are enabled, the new Edge Endpoints - Create Secret, Edge Endpoints - Manage, Edge Endpoints - View Secret, Edge Endpoints - View, Edge Webhooks - Manage, Edge Webhooks - Start/Stop, and Edge Webhooks - View permissions are automatically granted to the default System Administrator role. Administrators must grant this permission with the appropriate constraints to other roles, if necessary.

Set up a Webhook

To set up a webhook, you must first create an endpoint to link your hosted URL and the webhook. See Create a Webhook Endpoint.

Then, create a webhook to begin publishing events to your endpoint. See Create a Webhook.

Permissions

The following permissions apply to this functionality:

PERMISSION NAME PERMISSION DESCRIPTION CATEGORY
Edge Endpoints - Create Secret Grants access to create the secret key for Edge Endpoints used with Webhooks. This permission can be constrained by OU and User. This is an administrator permission. Edge
Edge Endpoints - Manage Grants access to view, create, edit, and verify Edge Endpoints used with Webhooks. This permission can be constrained by OU and User. This is an administrator permission. Edge
Edge Endpoints - View Secret Grants access to view the secret key for Edge Endpoints used with Webhooks. This permission can be constrained by OU and User. This is an administrator permission. Edge
Edge Endpoints - View Grants access to view Edge Endpoints used with Webhooks. This permission can be constrained by OU and User. This is an administrator permission. Edge
Edge Webhooks - Manage Grants access to view, create, and edit Edge Webhooks. This permission can be constrained by OU and User. This is an administrator permission. Edge
Edge Webhooks - Start/Stop Grants access to start and stop Edge Webhooks. This permission can be constrained by OU and User. This is an administrator permission. Edge
Edge Webhooks - View Grants access to view Edge Webhooks. This permission can be constrained by OU and User. This is an administrator permission. Edge