Creating Webhooks
RUCKUS One allows you to configure Webhook URL addresses to receive real-time notifications when incidents are created or updated in the application – much like email notifications. Webhooks help applications to communicate with each other in real-time and typically use a message or payload to communicate between each other. The message or payload contains real-time information about the incident.
Sample Webhook Message with Incident Details
{
"id": string, // Event ID
"type": "incident", // Type of webhook event, will be "incident"
"secret": string, // Webhook secret
"payload": { // incident payload
"status": string, // Incident status, e.g. "new" | "ongoing" | "finished"
"id": string, // Unique incident ID
"severity": string, // Incident severity, e.g. "P1" | "P2" | "P3" | "P4"
"link": string, // Link to incident
"title": string, // Title of incident
"category": string, // Category of Incident
"subCategory": string, // Sub-Category of incident
"startTime": string, // Incident start time in ISO 8601 format, e.g."2020-11-01T08:00:00.000Z"
"endTime": string, // Incident end time/last updated time in ISO
"duration": string, // Incident duration, e.g. "4d 10h"
"impactedAreaType": string, // Impacted area type, e.g. "Access Point", "Venue"
"impactedAreaName": string, // Impacted area name, e.g. "AP Name"
"impactedAreaHierarchy": string, // Impacted area hierarchy,
// e.g. "Venue_name (Venue) > AP_Group_name (inherit from Venue) (AP Group) > AP_name (AP Mac) (Access Point)"
"clientCount": number, // Total number of client under current hierarchy
"impactedClientCount": number, // Total impacted client under current hierarchy
"impactedClientPercentage": string, // Percentage of impacted client over total number of client under current hierarchy. e.g. "21.43%"
"rootCauses": string, // Root Causes of current incident
"recommendations": string // Recommendations to resolve current incident
}
}
For example, RUCKUS One communicates with ticketing applications in ServiceNow and Zapier via webhooks. Through webhooks, the incidents generated in RUCKUS One appear in the ServiceNow and Zapier applications, in real-time. Following is a work-flow to configure Webhooks for ServiceNow and Zapier applications.
The Webhooks page displays all the created webhooks in a table.
- Name: Displays the name of the webhook.
- URL: Displays the webhook URL created by appending the domain URL and the base API path from the other application.
- Status: Displays green color if webhook URL is enabled or grey color if it is disabled.
Under each attribute is a search field to limit the webhooks list based on the search criteria.
Select a webhook and click Edit to edit the webhooks information and click Delete to delete the webhooks.
You can select the number of webhooks displayed in the table from the Show rows drop down at the bottom of the table. The range is from five webhooks per table to 100 webhooks per table.
To create a webhook and integrate it with ServiceNow, refer to Integrating RUCKUS One Incident Webhook with ServiceNow Application.
To create a webhook and integrate it with your email, refer to Creating Email Notification for RUCKUS One Incidents using Zapier Application.
To create a webhook and integrate it with Zapier, refer to Create a New Salesforce Case for RUCKUS One Incident using Zapier Application.
To update a webhook that is integrated with Zapier, refer to Updating an Existing Salesforce Case for RUCKUS One Incident using Zapier Application.
Integrating RUCKUS One Incident Webhook with ServiceNow Application
Creating Email Notification for RUCKUS One Incidents using Zapier Application
Complete the following steps to set up the automation to trigger email notification for RUCKUS One incidents using Zapier:
Create a New Salesforce Case for RUCKUS One Incident using Zapier Application
Updating an Existing Salesforce Case for RUCKUS One Incident using Zapier Application
- Setup incident update by clicking https://zapier.com/shared/6bb3dc515e23d86796c3c70bfcc4121f0d41ae59.
- Repeat Step 2 to Step 25 from the Create a New Salesforce Case for RUCKUS One Incident using Zapier Application section.