Create CSE Actions

This topic has instructions for configuring CSE Actions.

About CSE Actions

You can use CSE Actions to issue a notification to another service when certain events occur in CSE. The supported Action types are:

• AWS Simple Notification Service (SNS)
• Demisto (Corex XSOAR)
• Email
• HTTP POST v2
• HipChat
• Microsoft Teams
• PagerDuty
• Recorded Future
• Slack
• Slack Webhook

An Action can be configured for Insight-related activity as described below in Insight Actions. You can also configure an Action to be run when a rule is automatically disabled, as described below in Rule Actions.

Insight Actions

You can configure an Action to send information about an Insight to another system, automatically when the Insight is created or on-demand from the Insight's Actions menu, and in the case of an HTTP POST v2 Action, when an Insight is closed.

What gets sent to the target system depends on the Action type. For some types—Slack, HipChat, Microsoft Teams, and PagerDuty—the notification contains a summary of the Insight with the following information:

• The Entity the Insight fired on.
• The MITRE tactic or tactics that form a portion of the Insight ID, which indicates which stage of the MITRE framework the Insight relates to. In the example below, the “Initial Access” tactic is shown.
• A link to the Insight in CSE.
  

For the other Action types—AWS Simple Notification Service (SNS), Demisto (Corex XSOAR), HTTP POST v2, and Slack Webhook—the notification includes the Insight itself in JSON format, and in some cases Signals or Records, depending on how you configure the Action.

Sensor Actions

You can configure an Action to send a notification when any Network Sensor goes offline.

Rule Actions

You can configure an Action to send a notification when a rule is automatically disabled. (CSE automatically disables rules that generate too many Signals, more than 100K in an hour, or 1 million in 24 hours.)

note

A Rule Action doesn't fire when a rule is enabled, moved in or out of prototype mode, or manually disabled.

The notification sent by a Rule Action contains the name of the rule and the reason it was disabled.

Create an Action

1. Click the gear icon near the top of the CSE UI and select Actions under Integrations.
   
2. On the Actions page, click Create.
   
3. The Create Action popup appears.
   
4. Name. Enter a name that communicates what the Action does.
5. Notifications. 
   • Insight. Click When Created to automatically generate a notification when any Insight is created, When Closed to automatically generate a notification when any Insight is closed, or On Demand to add the Action as an option in the Actions menu on the Insight details page. 
   • Sensor. Click When Offline to to automatically generate notifications when any sensor goes offline.
   • Rule. Click When Automatically Disabled to generate a notification when CSE disables a rule.
6. Active. Move the slider to the right if you’d like the Action to be enabled upon creation.
7. Type. Choose one of the following options, and follow the instructions for that Action type to complete creating your Action.
   • AWS Simple Notification Service
   • Demisto
   • Email
   • HTTP POST v2
   • HipChat
   • Microsoft Teams
   • PagerDuty
   • Recorded Future
   • Slack
   • Slack Webhook

AWS Simple Notification Service (SNS)

When you run this Action type for an Insight, CSE sends the full Insight in JSON format to SNS.

You can configure the action to authenticate with SNS using your AWS Access Key and Secret Access Key, or using the AssumeRole method.

1. Access Key. Enter your AWS Access Key, if you're using AWS Access Keys to authenticate.
2. Secret Key. Enter your AWS Secret Access Key, if you're using AWS Access Keys to authenticate.
3. Assume Role ARN. Enter the AssumeRole ARN, if that's how you want to authenticate.
4. Topic ARN. Enter the ARN of the SNS topic.
5. Region. Enter the AWS region for the SNS topic. 
6. Click Create.
   

Demisto (Corex XSOAR)

When you run this Action type for an Insight, CSE sends the full Insight in JSON format to Demisto.

1. API Key. Enter your Demisto API Key.
2. URL. Enter the URL of your Demisto API endpoint.
3. Client Certificate. Upload your client certificate for accessing the Demisto API endpoint.
4. Create Incident API Endpoint. Select /incident/json.
5. Extra Headers. Enter any additional headers you want to send, as line-delimited key:value pairs.
6. Exclude Records. Move the slider to the right if you don’t want to include Records in the notification.
7. Click Create.
   

Email

This Action type sends an email notification.

1. Recipients. Enter a comma-separated list of the email addresses to send the notification to.
2. Click Create.
   

When this Action runs on an Insight, the email notification contains:

• The Entity the Insight fired on.
• The MITRE tactic or tactics that form a portion of the Insight ID, which indicates which stage of the MITRE framework the Insight relates to.
• A link to the Insight in CSE.

HTTP POST v2

This Action type sends a HTTP POST notification. For an Insight Action, the notification contains the full Insight in JSON format. You can optionally configure the Action to send the Signals and Records associated with the Insight as well.

The output of the HTTP POST notification is the same as the JSON output from the /insight/:id API endpoint. For information about accessing API documentation, see CSE APIs.

Once you select HTTP POST v2  in the Type field a new Notification option—When Closed—appears, as highlighted in the screenshot below. Choose this if you want to send a notification when an Insight is closed in CSE.

1. URL. The URL to send the POST to.
   note

   The allowed destination ports for the HTTP Post are: 80, 8080, 443, 8443, and 8000. You can specify the port in the URL, but if the default port on the destination server is an allowable port, you don't need to.

2. Username. The username to use to access the URL.
3. Password. The password to use to access the URL.
4. Extra Headers. Additional HTTP headers to send with the POST.
5. Include Signals. Move the slider to the right to send the Signals associated with the Insight in the POST. 
6. Include Records. Move the slider to the right to send the Records associated with the Signal in the POST. 
7. Record Fields to Include. If desired, provide a comma-delimited list of selected Record fields to include (instead of all Record fields).
8. Click Create.
   

HipChat

This Action type sends a message to a HipChat room.

1. API Key. Enter your HipChat API key.
2. Room. Enter the HipChat room to send the notification to. 
3. Click Create.
   

When this Action type is run on an Insight, the message contains:

• The Entity the Insight fired on.
• The MITRE tactic or tactics that form a portion of the Insight ID, which indicates which stage of the MITRE framework the Insight relates to. 
• A link to the Insight in CSE.

Microsoft Teams

This Action type sends a Webhook notification to Microsoft Teams.

Configure Webhook connection in Microsoft Teams

Create a Webhook connection for the Microsoft Teams channel to which emails should be sent. Follow the instructions in Create Incoming Webhooks in Microsoft help.

Configure Action in CSE

1. URL. Enter the URL for the Webhook connection you created above. 
2. Click Create.
   

PagerDuty

This Action types sends a notification to PagerDuty.

1. Service Key. Enter your PagerDuty service key.
2. Subdomain. Enter your PagerDuty account subdomain.
3. Click Create.
   

The notification contains:

• The Entity the Insight fired on.
• The MITRE tactic or tactics that form a portion of the Insight ID, which indicates which stage of the MITRE framework the Insight relates to. 
• A link to the Insight in CSE.

Recorded Future

Recorded Future (RF) provides contextual Threat Intelligence through indicator lookups using a cloud-accessible API.

The CSE Recorded Future Action runs lookups on Record fields that contain IP addresses, domains, and hashes encountered in Insights, Signals, or both, depending on how you configure the Action. The lookup result is added as an enrichment to Insights, Signals, or both. 

Lookups will consume RF API credits.

Generate Recorded Future API token

1. In Recorded Future, go to User Settings > API Access > Generate New API Token.

2. On the Generate New Token page:

   1. Name. Enter a name for the token. 
   2. Integration. Select “Sumologic” from the list of integrations.

3. Click Generate.

   

4. Copy and save the token.

Create Action in CSE

1. API Key. Enter the Recorded Future API token you generated for the Sumo Logic integration. 

2. Enrich Insights. Move the slider to the right to enrich Insights.

3. Enrich Signals of Insights. Move the slider to the right to enrich Signals.

4. Click Create.

   

 View Recorded Future Enrichments

To view an Enrichment that’s been added to an Insight or Signal, navigate to the item and select the Enrichments tab.

Slack

This Action type sends a message to a Slack channel.

1. API Key. Enter your Slack API key.

2. Channel. Enter the Slack Channel that messages should go to.

3. Click Create.

   

If the Action was run on an Insight, the message contains:

• The Entity the Insight fired on.
• The MITRE tactic or tactics that form a portion of the Insight ID, which indicates which stage of the MITRE framework the Insight relates to. 
• A link to the Insight in CSE.

Slack Webhook

When you run this Action type on an Insight, CSE sends the complete Insight in JSON format to a Slack channel.

Configure Webhook connection in Slack

Create a Webhook connection for the Slack channel to which Insights should be sent. Follow the instructions in Sending messages using Incoming Webhooks in Slack help.

Configure Action in CSE

1. Webhook URL. Enter the URL of the Webhook you created above.

2. Click Create.