Add new Action
Last updated
Last updated
Before creating Action, you should create a new Action entry.
1. Click to Actions on the left pane.
2. On Knowledge Base Management screen, click Add (+) button on the right top section.
3. Select Action Type
4. Fields will change based on action type and service provider.
Refer to the following table to understand the fields in the above screen.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
E-Mail Address
Write the e-mail address of receiver.
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
Refer to the following table to understand the fields in the above screen.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
Phone Number
Write the phone number of receiver.
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
Refer to the following table to understand the fields in the above screen.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
API URL
An API URL, or endpoint, is a specific web address that allows communication between software systems by defining the location and functionality of a service or resource.
Query
An API query refers to a request made to an API endpoint, typically containing parameters or data, to retrieve or manipulate specific information from a service or database
Example:
{"eventid":"{eventid}","ruleid":"{ruleid}","rulename":"{rulename}","customstring":"{customstring}","numberoflogs":"{numberoflogs}","source":"{source}","message":"{message}","status":"{status}"}
Method
An API method specifies the action or operation to be performed on a resource, such as GET for retrieving data or POST for creating data.
Authorization
API authentication is the process of verifying the identity of clients accessing an API, often done using tokens, keys, or credentials.
Content Type
API content type specifies the format of the data being sent or received in an API request or response.
Examples:
· application/json
· application/xml
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
This fields are the same for all of the sms providers which are clickatell, messagebird, istanbulbt, verimor, fastsms, jetsms, turatelsms
Refer to the following table to understand the fields in the above screen.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
Phone Number
Write the phone number of receiver.
Sender Name
Write the name of the sender
Username
Username for login to sms provider
Password
Password for login to sms provider
API ID / Account
Account name or API ID of sms provider
Maximum Length of Text
Set the maximum length of sms text
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
Refer to the following table to understand the fields in the above screen.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
API Token
Unique identifier provided by the Telegram API to authenticate and access bot APIs, allowing secure interaction between applications and Telegram's platform.
Room ID
Unique identifier representing a specific chat or group conversation within the Telegram messaging platform, used for directing messages or actions to that particular room.
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
Refer to the following table to understand the fields in the above screen.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
API Key
Unique authentication token provided to users, granting access to Logpusher's API endpoints for managing log data.
Username
Username for login to logpusher
Password
Password for login to logpusher
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
Integration Key
Unique identifier used to link and authenticate external services or systems with PagerDuty, enabling the triggering and routing of incidents to the correct responders or teams.
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
1. You can get a new integration key from your PagerDuty account.
2. Go to services section on the PagerDuty.
3. Click on one of your services that you want to make integration.
4. Click on the Integrations section and click to New Integration button.
5. Give an integration name, choose Use our API directly option and select Events API v2 from the list. Click on Add Integration button to complete the task.
6. Now you will see your Integration Key in the Integrations section.
Refer to the following table to understand the fields in the above screen.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
Endpoint ID
The endpoint ID in VictorOps represents a unique identifier assigned to an integration or target destination, enabling the system to route and deliver incident notifications to specific external systems or tools.
Routing Key
Routing key is a configurable identifier used to direct and route incident notifications to specific on-call teams or individuals based on predefined routing rules and policies.
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
1. You can get endpoint id and the routing key from your VictorOps account.
2. Go to settings section on the VictorOps.
3. Click on Alert Behavior and then click on the Integrations button.
4. Click on the Rest {Generic} button.
5. Click on Enable Integration button to complete the task.
6. Now you will see your Endpoint ID in the URL to notify section.
7. Now click on the Routing Keys button.
8. You will see your routing keys. You may use one of them or you can create new one by clicking on Add Key button.
9. Type your new routing key, type an escalation policy and save changes. In this example, your routing key is VirtualMetric.
Refer to the following table to understand the fields in the above screen.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
Instance URL
If you use on-premise / old version of ServiceNow, you can type your instance url as subdomain.domain.com If you use new version of ServiceNow, you can just type your instance name as mycompany or mycompany.service-now.com.
Caller ID
Caller ID refers to the identifier associated with the user or system making a request or creating a record within the ServiceNow platform.
Username
Username for login to sms servicenow
Password
Password for login to sms servicenow
Category
This field is not mandatory. Category of rule
Company
This field is not mandatory. Company of rule
Assigned To
This field is not mandatory. Assignee of the rule
SubCategory
This field is not mandatory. Subcategory of the rule
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
You can get caller id from your ServiceNow instance.
1. Go to user management page on the ServiceNow. Click on the user that you want to use as Caller.
2. Click on Copy sys_id button to copy and get Caller ID.
Refer to the following table to understand the fields in the above screen.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
API Key
API key in OpsGenie is a unique token used for authentication and authorization to access OpsGenie's API endpoints, enabling integration and interaction with the OpsGenie platform.
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
You can get api key from your OpsGenie account.
1. Go to integrations section on the OpsGenie.
2. Click on API button.
3. Type the integration name, copy api key and click on the Save Integration button.
Refer to the following table to understand the fields in the above screen.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
Integration URL
The endpoint address where xMatters sends or receives notifications and data, facilitating communication between xMatters and external systems or applications.
Property Name: Severity
Defining the severity level of an event or incident within the xMatters platform, typically used in configuring notification rules or handling escalation policies.
Property Name: Owner
Defining the owner of an event or incident within the xMatters platform, typically used in configuring notification rules or handling escalation policies.
Property Name: Message
Defining the message an event or incident within the xMatters platform, typically used in configuring notification rules or handling escalation policies.
Property Name: Details
Defining the details an event or incident within the xMatters platform, typically used in configuring notification rules or handling escalation policies.
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
You can get these details from your xMatters account.
1. Go to developer section on the xMatters and click on the Communication Plans option. Click on your Communication Plan in the list view.
2. Click on Edit button and select Integration Builder option.
3. On the Inbound Integration, click on the Add button.
4. Select URL Authentication, fill the form and click on the Add Inbound Integration button.
5. Copy your Integration URL, and click on the View Instructions button.
6. Take a note of the fields names and close the modal.
Refer to the following table to understand the fields in the above screen.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
API URL
An API URL, or endpoint, is a specific web address that allows communication between software systems by defining the location and functionality of a service or resource.
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
You can get API Url from your AlertOps account.
1. Click on the Inbound Integrations on the left menu.
2. Click Add Web API Integration button on the right.
3. Select Custom from the list.
4. Fill the required fields and click on the Advanced Settings tab.
5. This is how you should fill the fields on mapping. After that, click on Generate URL to get your API URL.
6. Click on the Save Changes button to complete this task.
Refer to the following table to understand the fields in the above screen.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
URL Address
Endpoint location where requests are sent and received to interact with Micro Focus' services or applications programmatically.
Category
This field is not mandatory. Category of rule
Template
Defines a structured format for creating or updating configurations, policies, or data within the OMi system, facilitating automated interaction through XML-based requests
Example will come automatically.
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
Refer to the following table to understand the fields in the above screen.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
IP Address
The numerical label assigned to each device connected to a computer network is called an "IP address." An IP address is typically represented in the format XXX.XXX.XXX.XX, where each "XXX" is a number ranging from 0 to 255, and the "XX" is a similar two-digit number. IP addresses are used to uniquely identify and locate devices on a network.
Port
A specific endpoint for data exchange between two devices or applications within a network.
Trap Object ID
The trap object ID in SNMP traps denotes a unique identifier representing the specific event or condition being reported, helping to classify and understand the nature of the trap message received by the SNMP manager.
Template
The template of an SNMP trap defines the structure and content format for trap messages, providing a standardized layout for the information communicated between SNMP agents and managers.
Credential Type
Select a proper credential type and credential.
· None
· SNMPv2: This authentication method is used to monitor and manage networked devices, such as routers, switches, servers, and network printers.
· SNMPv3: This authentication method is used to monitor and manage networked devices, such as routers, switches, servers, and network printers. It is an enhanced and more secure version of SNMP compared to its predecessors, SNMPv1 and SNMPv2c.
Template
Defines a structured format for creating or updating configurations, policies, or data.
Example will come automatically.
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
Refer to the following table to understand the fields in the above screen.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
IP Address
The numerical label assigned to each device connected to a computer network is called an "IP address." An IP address is typically represented in the format XXX.XXX.XXX.XX, where each "XXX" is a number ranging from 0 to 255, and the "XX" is a similar two-digit number. IP addresses are used to uniquely identify and locate devices on a network.
Port
A specific endpoint for data exchange between two devices or applications within a network.
Template
The template of an TrueSight defines the structure and content format for messages, providing a standardized layout for the information communicated between TrueSight and managers.
Routing ID
Routing ID refer to the identifier used for directing or forwarding incoming data, such as events or alerts, to specific destinations or workflows within the TrueSight monitoring and management platform.
Routing Type
Routing Type refers to the method or criteria used to determine the path or destination for processing incoming data, aiding in directing events or alerts to appropriate workflows or handlers within the TrueSight system.
Credential Type
Select a proper credential type and credential.
· None
· Basic – Selecting this option provides you with another Field called Credential from where you can select an appropriate option
· Bearer Token – Selecting this option provides you with another Field called Credential from where you can select an appropriate option.
Template
Defines a structured format for creating or updating configurations, policies, or data.
Example will come automatically.
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
Refer to the following table to understand the fields in the above screen.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
Integration Key
Unique identifier used to authenticate and link external applications or services with Slack, enabling the sending of messages or data to specific channels or users.
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
You can get integration key from your Slack account.
1. Go to App section on the left and click + button.
2. Search for webhook and click on the Install button of the Incoming WebHooks.
3. Click on the Add Configuration button.
4. Choose a channel and click on Add Incoming WebHooks Integration button to complete the task.
5. Now you will see your Integration Key in the Webhook URL section.
Refer to the following table to understand the fields in the above screen.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
Token
Authentication credential used to authorize access and interactions between external applications or services and the HipChat platform, allowing for sending messages or performing actions within HipChat rooms.
Room ID
Unique identifier representing a specific chat room or group within the HipChat platform, used to direct messages or activities to that particular room.
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
You can get token and the room id from your HipChat account.
1. Open the room actions menu, click on Tokens button, then create a new room token.
2. Open the room actions on the menu, click on the room you created. It will show you the API ID which is your room ID.
Refer to the following table to understand the fields in the above screen.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
Token
Authentication key allowing external applications to interact with the Stride platform's APIs.
Site ID
Unique identifier for an organization or workspace within the Stride platform.
Room ID
Unique identifier for a specific chat room or conversation, used to direct messages or activities to that particular room within Stride.
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
You can get token, site id and the room id from your Stride account.
1. Go to App section on the right and click Add an app button.
2. Click on the Connect your app button.
3. Type token name, choose chat room and click on the Create button.
4. Copy integration token, site id and room id, then click Done button to complete the task.
Refer to the following table to understand the fields in the above screen.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
Webhook URL
Endpoint that allows external applications to send messages or data into a specific Teams channel.
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
You can get Webhook URL from your Microsoft Teams account.
1. Go to Store section on the left menu.
2. Search for webhook and click on the Incoming WebHook.
3. Choose a channel and click on the Set Up button.
4. Type name and click on the Create button to complete the task.
5. Now you will see your Webhook URL in the section. Click on the Done button to close the window.
Refer to the following table to understand the fields in the above screen.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
Webhook URL
Endpoint that allows external applications to send messages or data into a specific Flock channel.
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
You can get Webhook URL from your Flock account.
1. Go to Apps section on the right menu.
2. Click on the Build Apps menu on the top frame.
3. Click on the Webhook menu on the left frame.
4. Click on the Add button of Incoming WebHook.
5. Choose a channel, type name and click on the Save and Generate URL button to complete the task.
6. Now you will see your Webhook URL in the window. Click on the X button to close the window.
Refer to the following table to understand the fields in the above screen.
Language
Select a proper language from dropdown.
· English
· French
· German
· Turkish
Friendly Name
A label or name that is assigned to a Action.
Connection String
String of parameters used by applications to establish a connection to a SQL Server database.
Database
Structured collection of organized data and schema objects managed by the SQL Server engine.
Table Name
Identifier for a structured data storage object containing rows and columns that define a specific dataset within a database.
Columns
Define the structure of a table by specifying the data types and attributes associated with individual fields. There should be comma (,) between columns
Example: Name,Expression,RecordStatus
Values
Define the value of the colums. There should be comma (,) between values.
Example: '{subject}','{message}',1
State
Define state of rule.
Severity
Define severity of rule
Urgency
Define urgency of rule
Time Zone
Select a proper time zone from dropdown.
Enable Active Hours
You can set the timeperiod of actions
Status
Rule can be enabled/disabled from status field.
