Skip to main content
Gainsight Inc.

Webhooks

The article describes how an admin can add webhooks and use them in notifications.

The article describes how an admin can add webhooks and use them in notifications.

Overview

Webhooks in Staircase AI allow you to trigger real-time actions in external systems the moment a specific event occurs. Once configured, webhooks can be selected as a notification destination, enabling automated workflows across your tools without manual intervention.

This closes the gap between signal detection and action. When Staircase AI detects a risk or opportunity, it can immediately trigger a response in your connected systems without a human in the loop.

Webhooks also enable engineers to programmatically connect systems and automate workflows. For example, they can trigger a welcome email when a new decision-maker is identified or schedule a meeting when a churn risk is detected. Webhooks can also be used to automatically create tasks or support tickets based on specific events. This capability aligns with the needs of technical customers looking to integrate and synchronize their systems.

Example Business Use Case

An admin wants to automatically trigger actions in external systems when Staircase AI detects specific customer signals. By configuring a webhook and selecting it as a notification destination, Staircase AI sends the signal to the connected system in real time. This removes the need for manual monitoring and ensures faster response to critical customer signals.

Set Up Webhooks

Before you add a webhook in Gainsight, ensure that you have a working application on your server that is ready to receive requests. Each application has a dedicated endpoint URL, and the structure of that URL depends on the destination system.

For example: https://your-domain.atlassian.net/rest/api/3/issue or https://hooks.zapier.com/hooks/catch/123456/zbB61

To create webhooks:

  1. Navigate to Settings > Configurations > Webhooks.
  2. Click Add webhook. The Add webhook dialog box appears.

    Settings page showing Webhooks configuration with Account personnel change webhook and Add webhook option for creating real-time event notifications.
     
  3. Enter Label, Description (optional) and Webhook URL.

    Add webhook dialog showing label, description, and webhook URL fields for configuring real-time renewal risk escalation notifications.
     
  4. Click Add. The Webhook secret key dialog box appears.
  5. Click Copy to clipboard icon to copy the webhook secret key. You’ll use it to verify that incoming calls are genuinely from Staircase

    Webhook secret key dialog displaying generated validation key with copy option after successful webhook creation for secure payload verification.
     
  6. Click Close.

You can regenerate the webhook secret key at any time using the Regenerate secret option from the three-dot vertical menu.

Webhooks settings displaying Renewal Risk Escalation webhook with Regenerate Secret option for renewing the validation key securely.

You can disable a webhook using the Disable option to pause notifications and re-enable it later when needed. This allows you to temporarily stop notifications without deleting the webhook.

Webhooks settings showing Renewal Risk Escalation webhook disabled with Enable option available to restore real-time risk notifications.

Staircase AI transmits the secret key to the webhook endpoint as a hashed value in the request header under x-staircase-signature. This allows the endpoint to verify that the request originated from Staircase AI.

Use Webhooks in Notification

After configuring webhooks, create a notification to start receiving event alerts. To do so:

  1. Navigate to Settings > Notifications.
  2. Click Add notification to add a new notification. Alternatively, click Edit to modify an existing notification. For more information on how to configure notifications, refer to the Configure Notifications section in Set Up Email and Slack Notifications in Staircase article.
  3. In the Notify section, select Webhook.
  4. Select a webhook from the dropdown list.

    Add Notification dialog showing webhook selected as the notification method for account personnel changes with active account status filter.
     
  5. Click Save.
    An example of the sent data:

    Webhook request details showing request headers, JSON payload, Staircase URL, account data, and signature for validating event notifications.

    Note: The request header includes the hashed secret key under "x-staircase-signature" for secure identification
  6. From the three-dots vertical menu, click Test notification. The Test notification dialog box appears.

    Notification settings showing webhook alerts for account personnel changes with Test Notification option to verify webhook delivery and setup.
     
  7. Select an Account from the dropdown list.
  8. Click Test.

    Test Notification dialog showing selected account, configured account personnel change webhook, destination URL, and Test button to verify delivery.

  • Was this article helpful?