Webhook Notifier

Create an outgoing webhook to send notifications to other services that support HTTP commands or use the built-in integrations with social or communication services.

Creating an Outgoing Webhook – Send notifications to other systems that support HTTP commands.
Connecting to Social Media Services – Send notifications to Facebook and X pages.
Connecting to Collaboration Tools – Send notifications as messages to a Slack or Microsoft Teams channel.

Access:

Go to Configuration > Integrations > Outgoing Webhook.

Managing your Outgoing Webhooks

Icon	Action
	Creating an Outgoing Webhook Connecting to Social Media Services Connecting to Collaboration Tools
	Sort the Actions by Name
	Filter the Actions
	Edit the selected Action
	Delete the selected Action

Creating an Outgoing Webhook

Note: The outgoing webhook requires you to understand the webhook settings required by the service you are connecting to. Refer to the service documentation for this information.

Use an outgoing webhook to send notifications to other services that support HTTP commands.

For most integrations, you will need an account with the service to use their APIs and SDKs. Typically, when making requests to the REST API, an Authentication HTTP header is used to identify the requesting user. This header generally must include an access token. You will need to obtain the access token from the service you are integrating with.

Most of the information you require to create this notification should be provided by the service you are connecting to.

Review the service documentation to determine:
1. how to retrieve the connection URL
2. the content-type
3. required header or query information
4. syntax rules for the body of the content
Go to Configuration > Integrations > Outgoing Webhook.
Select New Outgoing Webhook.
Complete the fields as described in the Field Reference table and based on the service documentation.
Create a Notification using this webhook as an endpoint.

Field Reference

Field	Description
Name	Your name for the outgoing webhook, which you will reference in your notifications.
Method	Type of HTTP action: GET, POST, PATCH, PUT, and DELETE.
Authorization Type	Type of authorization used in the request. Your service will define which type you should choose. None (default) Basic Auth – Supply your Username and Password credentials. Digest Auth – Supply your Username and Password credentials. Revolution only supports Digest Auth with the quality of protection (qop) security enhancements. OAuth – Supply your Token for authorized login for the external service. See Creating an OAuth Token.
URL	Where to send your notification requests. Refer to your service documentation.
ContentType	(not in GET or DELETE) The Content-type for the HTTP action. Refer to your service documentation.
Escape Text	Characters used to escape variables. You can change these characters in case of conflict with your Body text.
Use UTC	(not in GET or DELETE) Enable this to use Coordinated Universal Time with date and time variables.
Date Format Time Format	(not in GET or DELETE) Alter the default values for these fields to customize the date and time formats for the related text variables available in the Body field. The format specifiers are based on those defined in C#.
Query Parameters	(GET only) Refer to your service documentation. Allows Variables.
Headers	Header key-value pairs. Refer to your service documentation. Allows Variables.
Body	(not in GET or DELETE) The content of the HTTP action. Refer to your service documentation. Allows Variables.
External Media URL	Select this option if you are connecting to an external service. When enabled, Revolution will upload any referenced media to the Cloud with an internet accessible URL such that the service can use your media.
Fire on Activation	Issue the HTTP command at the start of the notification. This behavior is not available for live notification types, such as MRCP TTS, One-way, and Two-way.
Fire on Iteration	Issue the HTTP command for each iteration.
Fire on Completion	Issue the HTTP command upon completion of the notification.
Success Code	Revolution reports the notification a success if it receives this code from the service. Refer to your service documentation.

Some of the fields allow for the use of Variables, using the default escape characters (%%). You can choose these variables from the Add text variables drop-down menu.

Menu Selection	Variable	Description
Title	%%Title%%	References the text from the Title field of the notification.
Body	%%Body%%	References the text from the Body field of the notification.
Latitude Longitude Elevation	%%Latitude%% %%Longitude%% %%Elevation%%	Returns location information from the triggering endpoint
Radius	%%Radius%%	Returns the radius value associated with the location.
Location	%%Location%%	Returns the activating source location, if specified. For example, the address if using a mobile trigger with location information enabled.
Caller ID	%%Prompt%%	Returns the Caller ID or prompt. For example, the username when the notification is web-activated.
Audio	%%Audio[n]%%	References the nthe audio file associated with the notification, where 0 (zero) references the first audio file. For example, if your notification has only one referenced image, you would use the variable: %%Audio[0]%%.
Image	%%Image[n]%%	References the nthe image associated with the notification, where 0 (zero) references the first image. For example, if your notification has only one referenced image, you would use the variable: %%Image[0]%%.
Date Time Time+5 Time+10 Time+30	%%Date%% %%Time%% %%TimePlus5%% %%TimePlus10%% %%TimePlus30%%	Reference the date and time values for when the notification starts. The Plus variables allow you to reference a time adjusted by 5, 10, or 30 seconds. You can customize the date and time values with the Date Format and Time Format fields. By default, the time is local, however you can change this by selecting Use UTC.
Activation Mode	%%Mode%%	Returns either Activation, Iteration, or Completion, depending on your Fire On settings.

Creating an OAuth Token

Important: This section assumes you have experience with OAuth authentication and any requirements from the service you are connecting to. Refer to the OAuth 2.0 site for information about this protocol.

When you create an outgoing webhook that uses OAuth authentication, you must create a Revolution token to facilitate the communication.

Your service may require one of several different credential methods, which you define with the Grant Type field. The most common and secure method is the Authorization Code type, which requires direct interaction with the service. While some may require simple client credentials as provided by the service, or also require your individual login and password credentials. You can also use a custom method, relying primarily on custom parameters, for cases where the service is not fully compliant with OAuth standards.

The tokens from the service may or may not come with an expiration date. They also may or may not allow you to refresh the tokens after expiration.

Go to Configuration > Integrations > Token.
Select New
For Name, enter a descriptive string.
For Available in All Sites:
- Enable to ensure all your site locations have access.
- Disable and select a Site to limit which site has access.
For Token Type, select OAuth.
For Grant Type, select the credential method, which is defined by your service.
- Client Credentials – Services using this method require authorization based on client credentials from the service.
- Password – Services using this method require authorization based on client credentials from the service as well as user credentials.
- Authorization Code – Most services will use this method, which results in a three-legged authorization between the Service, Revolution, and the user. You will complete authorization in a separate pop-up window connecting you directly to the service.
- Custom – Use this for services that do not strictly follow OAuth standards. You will most likely be using the Custom Parameters section to define any requirements. Revolution will make an effort to interpret the information received from the service, but that information may not be a standard response.
For Client ID and Client Secret, enter the credential information for the service.
(Only if Grant Type is Authorization Code) For Authorize URI, enter the URI supplied by your service.
(only if Grant Type is Password) For Username and Password, supply your credentials for the service.
For Access Token URI, enter the token URI supplied by your service.
(optional) Disable Send authorization as Basic header. Only disable this if the service says you should send the client credentials with the parameters.
(optional) Add Custom Parameters, as required by the application.

For the key field, characters are restricted to alpha-numeric, hyphen (-), and underscore (_).
Select Authorize, to verify the creation of the Token.
- If your Grant Type is Authorization Code, you will be prompted to interact with the service. Follow the onscreen prompts to complete the authorization.
- For all other Grant Types, Revolution interacts with the service to authorize the token.
Note: After Authorization, your information is no longer shown, other than the Token Type setting.
Analyze the authorization results.
- Expiration Information – This note shows expiration information for the token, either the specific date and time or that the expiration time is unknown.
- Automatically Refresh access token – When enabled, Revolution will attempt to refresh the token at a set time (Refresh Interval).
  Important: If you allow Revolution to automatically refresh, potentially sensitive information may be stored to attempt the refresh.
- Refresh Token Information – If this note appears, it is because the service did not provide a refresh token.
- Refresh Interval – (only available if you enable automatic refresh).
  - If the token returned a specific expiration time, this value defaults to zero (0) which means that Revolution will refresh the token at the time of expiration.
  - If the token did not define an expiration time, this value defaults to 1440 (1 day).
  You can alter the default values as you need.
  Note: If you activate a notification that uses an expired, non-refreshed OAuth token, it will fail. The error message in the activation status reports the HTTP code returned by the service did not match the success code defined in the webhook, such as "401 != 200".
Select Save to finalize the token creation process. You can now reference this token when creating your outgoing webhook.

Outgoing Webhook Examples

Each setup will be different depending on your vendor's API and customer settings.

The following are example setups for Everbridge, Atlassian OpsGenie, Cisco Webex Teams, and Microsoft Teams.

Everbridge Example

Review your Everbridge documentation to determine how to connect a webhook to their service.
Using the provided information, follow the instructions in Creating an Outgoing Webhook. Your fields may appear as shown:
- Name: Enter a name for your later reference
- Method: POST
- URL: Something similar to:
  
  https://api.everbridge.net/rest/notifications/1111111
- ContentType: application/json
- Escape Text: %%
- Headers: Authorization - <Key>
- Body: Something similar to:
  
  {
  "sourceTemplateId":1111111
  }

Atlassian OpsGenie Example

Review your OpsGenie documentation to determine how to connect a webhook to their service.
Using the provided information, follow the instructions in Creating an Outgoing Webhook. Your fields may appear as shown:
- Name: Enter a name for your later reference
- Method: POST
- URL: Something similar to:
  
  https://api.opsgenie.com/v2/alerts
- ContentType: application/json
- Escape Text: %%
- Headers: Authorization - GenieKey <Key>
- Body: Something similar to:
  
  {
  “Message”: “%%Title%%”,
  “alias”: “Alias Name”,
  “description”:”%%Body%%”,
  “actions”:[“Restart”, “ExampleAction”],
  “tags”:[OverwriteQuietHours”, “Critical”],
  “details”:{“key1”:”value1”},
  “entity”:”Example entity”,
  “priority”:”P1”
  }

Cisco Webex Teams Example

Review your Webex Teams documentation to determine how to connect a webhook to their service.
Using the provided information, follow the instructions in Creating an Outgoing Webhook. Your fields may appear as shown:
- Name: Enter a name for your later reference
- Method: POST
- URL: Something similar to:
  
  https://api.ciscospark.com/v1/webhooks/incoming
- ContentType: application/json
- Escape Text: %%
- Headers: Authorization - Bearer <Key>
- Body: Something similar to:
  
  {“text”:”%%Title%% - %%Body%%”}

Google Chat Example

Review your Google Chat documentation to determine how to connect a webhook to their service.

Using the provided information, follow the instructions in Creating an Outgoing Webhook. Your fields may appear as shown:

Name: Enter a name for your later reference
Method: POST
URL: Something similar to:

https://chat.googleapis.com/v1/spaces/XXXXXXX
ContentType: application/json
Escape Text: %%
Headers: Charset - UTF-8

Body: Something similar to:

{
  "cards": [
  { 
    "header": { 
       "title": "  This is a title test  ",
       "subtitle": "security@company.com", 
    },
    "sections": [ 
        {
          "widgets": [ 
             {
                "image": { "imageUrl": URL } 
             }, 
             { 
                "textParagraph": { 
                   "text": " This is a body test "
                }
             } 
          ]
        }
     ] 
   }
  ]
}

Microsoft Teams Example

Review the Microsoft Teams documentation to determine how to connect a webhook to their service. Search the Microsoft Teams website for "Sending messages to Connectors and Webhooks".
1. Their connection relies on JSON formatting for POST actions
2. They show how to use the More options selection to obtain the webhook URL
3. They provide syntax information for delivering static information as well as allowing for actionable messages, including button feedback.

Using the provided information, follow the instructions in Creating an Outgoing Webhook. Your fields may appear as the following:

Name: Enter a name for your later reference
Method: POST
URL: What you obtained from the Microsoft Teams process.
ContentType: application/json
Escape Text: %%
Headers: Enter as needed

Body: Something similar to:

{
"@type": "MessageCard",
"@context": "http://schema.org/extensions",
"themeColor": "0076D7",
"summary": "Revolution Notification",
"sections": [{
	"heroImage": {"image": "web_location"}
	}, {
	"startGroup": true,
	"title": "Notification Details",
	"activityTitle": "![AlertImage](%%Image[0]%%)Revolution Alert Notification",
	"activitySubtitle": "%%Title%%",
	"activityImage": "%%Image[0]%%",
	"facts": [{
		"name": "Title",
		"value": "%%Title%%"
        }, {
		"name": "Body",
		"value": "%%Body%%"
        }],
	"markdown": true
    }],
"potentialAction": [{
	"@type": "OpenUri",
	"name": "Listen to Audio",
	"targets": [{
		"os": "default",
		"uri": "%%Audio[0]%%"
		}]
	}]