Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FX-4786] Guide for Outlook Email Notifications #544

Merged
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ Manage your connections within the Projects tab of the Integration Builder

1. Click the create connection button

![Create connection folder view](/integrations/integration_builder/connect_your_apps/set_up_connection/folder_view.png "Create connection folder view")
{{% image src="/integrations/integration_builder/connect_your_apps/set_up_connection/folder_view.png" alt="Create connection folder view" %}}

2. Select the connector for the application that you want to connect to

![Select connector](/integrations/integration_builder/connect_your_apps/set_up_connection/select_connector.png "Select connector")
{{% image src="/integrations/integration_builder/connect_your_apps/set_up_connection/select_connector.png" alt="Select connector" %}}

3. Input the URL of the application to connect to and the authentication information

![Enter system details](/integrations/integration_builder/connect_your_apps/set_up_connection/enter_system_details.png "Enter system details")
{{% image src="/integrations/integration_builder/connect_your_apps/set_up_connection/enter_system_details.png" alt="Enter system details" %}}

4. Click connect

Expand All @@ -30,11 +30,11 @@ You can now use triggers and actions within recipes to interact with the app you

1. Select the connection that you would like to edit

![Select connection](/integrations/integration_builder/connect_your_apps/edit_connection/select_connection.png "Select connection")
{{% image src="/integrations/integration_builder/connect_your_apps/edit_connection/select_connection.png" alt="Select connection" %}}

2. Disconnect the connection. Recipes that are using the connection will stop working while the connection is disconnected.

![Disconnect connection](/integrations/integration_builder/connect_your_apps/edit_connection/disconnect_connection.png "Disconnect connection")
{{% image src="/integrations/integration_builder/connect_your_apps/edit_connection/disconnect_connection.png" alt="Disconnect connection" %}}

3. Update the connection information

Expand All @@ -46,7 +46,7 @@ You can now use triggers and actions within recipes to interact with the app you

2. Click the Delete Connection button. Any recipes that use this connection will stop working

![Delete connection](/integrations/integration_builder/connect_your_apps/delete_connection/delete_connection.png "Delete connection")
{{% image src="/integrations/integration_builder/connect_your_apps/delete_connection/delete_connection.png" alt="Delete connection" %}}

## Available connectors

Expand Down
14 changes: 7 additions & 7 deletions content/en/Integrations/IntegrationBuilder/how-to-guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@ when the finding whose state was updated is associated to a certain asset or pen

To see the filters available for a trigger, click on your trigger and then click the `optional fields available` button.

![Show trigger filters](/integrations/integration_builder/how_to_guides/trigger_filters/show_trigger_filters.png "Show trigger filters")
{{% image src="/integrations/integration_builder/how_to_guides/trigger_filters/show_trigger_filters.png" alt="Show trigger filters" %}}

You may then select the filters to add.

![Add filters](/integrations/integration_builder/how_to_guides/trigger_filters/add_filters.png "Add filters")
{{% image src="/integrations/integration_builder/how_to_guides/trigger_filters/add_filters.png" alt="Add filters" %}}

You can then set the value of the trigger.
Some trigger filters accept only a textual input.
Some trigger filters accept textual input and have a dropdown box that may be used to select a value.

![Set filter value](/integrations/integration_builder/how_to_guides/trigger_filters/set_filter_value.png "Set filter value")
{{% image src="/integrations/integration_builder/how_to_guides/trigger_filters/set_filter_value.png" alt="Set filter value" %}}

## External Ticket References

Expand All @@ -47,8 +47,8 @@ For the above-mentioned purposes to be achieved, it is important that your ticke

Here's an example of what these steps look like in a recipe:

![Search ticket reference](/integrations/integration_builder/how_to_guides/external_ticket_references/search_ticket_reference.png "Search ticket reference")
![Create ticket reference](/integrations/integration_builder/how_to_guides/external_ticket_references/create_ticket_reference.png "Create ticket reference")
{{% image src="/integrations/integration_builder/how_to_guides/external_ticket_references/search_ticket_reference.png" alt="Search ticket reference" %}}
{{% image src="/integrations/integration_builder/how_to_guides/external_ticket_references/create_ticket_reference.png" alt="Create ticket reference" %}}

See [our public API documentation](/cobalt-api/v2/) for more information about the properties of an external ticket reference.

Expand All @@ -57,7 +57,7 @@ See [our public API documentation](/cobalt-api/v2/) for more information about t
When you are building recipes for creating tickets in a ticketing system, you may want to customize the fields that you are setting on the tickets.
To set extra optional fields for tickets, you can use the `optional fields available` button within the create ticket action to set extra fields.

![Optional fields button](/integrations/integration_builder/how_to_guides/optional_fields_button.png "Optional fields button")
{{% image src="/integrations/integration_builder/how_to_guides/optional_fields_button.png" alt="Optional fields button" %}}

## Mapping fields

Expand All @@ -68,7 +68,7 @@ When you select an action input, the "Recipe data" drawer will open.
Within this drawer, the outputs from the actions and triggers within your recipe will appear as "data pills".
You can simply drag-and-drop the data pills from the drawer into action input fields as desired.

![Data pill mapping](/integrations/integration_builder/how_to_guides/data_pill_mapping.png "Data pill mapping")
{{% image src="/integrations/integration_builder/how_to_guides/data_pill_mapping.png" alt="Data pill mapping" %}}

## Authentication best practices

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
title: "Configure Outlook email notifications"
linkTitle: "Configure Outlook email notifications"
weight: 40
---

## Configure Outlook email notifications

In order to configure Outlook to send emails every time a new finding gets created, we need to do the following:

1. Create an Outlook connection.
2. Find and select a recipe (2 options):
- [Cobalt > Outlook] When pentest finding moved to Pending Fix, send email notification
- [Cobalt > Outlook] When DAST finding is detected, send email notification
3. Copy and customize the recipe
1. Configure which pentest should trigger notifications when findings get created.
2. Configure which email address to send the to.
wolfgangbecker marked this conversation as resolved.
Show resolved Hide resolved
4. Start the recipe

The following is a step-by-step guide to walk you through the configuration process.

### 1. Create an Outlook connection

The following is a quick guide on how to create a Workato connection for Microsoft Outlook.
In case you're looking for a more comprehensive and general guide on how to manage connections, check [here](/integrations/integrationbuilder/connect-your-applications/).

Go to the `Integration Builder` > `Projects`. Select or create a project on the left-side of the page. Then click on the "Create" button on the top-right and choose the "Connection" option.

{{% image src="/integrations/integration_builder/findings_outlook_notifications/create_connection_step1.png" alt="Create a connection for your project" %}}

A "New Connection" page will show up. Look for "Outlook" and select the corresponding tile. You can optionally use the search field to quickly find the connection.

{{% image src="/integrations/integration_builder/findings_outlook_notifications/create_connection_step2.png" alt="Pick an Outlook connection" %}}

After selecting the connection type, a form will appear. Provide a name, select a location and click on "Sign in with Windows". If needed, you can configure "Advanced settings" as well.

{{% image src="/integrations/integration_builder/findings_outlook_notifications/create_connection_step3.png" alt="Configure the connection" %}}

Once signed in with Microsoft, you should get a confirmation that the connection got successfully created.

{{% image src="/integrations/integration_builder/findings_outlook_notifications/create_connection_step4.png" alt="Save the connection" %}}

### 2. Find and select a recipe

Go to the `Integration Builder` > `Library` and select Outlook.

{{% image src="/integrations/integration_builder/findings_outlook_notifications/configure_outlook_notification_step1.png" alt="Outlook tile" %}}

Choose between both options:
wolfgangbecker marked this conversation as resolved.
Show resolved Hide resolved
A. [Cobalt > Outlook] When pentest finding moved to Pending Fix, send email notification
B. [Cobalt > Outlook] When DAST finding is detected, send email notification
For the purpose of this guide, we'll go with "When pentest finding moved to Pending Fix, send email notifications". The process is very similar for DAST findings, so these steps should help you out in that case as well.
wolfgangbecker marked this conversation as resolved.
Show resolved Hide resolved

{{% image src="/integrations/integration_builder/findings_outlook_notifications/configure_outlook_notification_step2.png" alt="Outlook recipes" %}}

### 3. Copy and customize the recipe

Click on "Use this recipe".

{{% image src="/integrations/integration_builder/findings_outlook_notifications/configure_outlook_notification_step3.png" alt="Use Outlook recipe" %}}

You will be prompted to copy the recipe. Choose a preferred location and click "Copy and save".

{{% image src="/integrations/integration_builder/findings_outlook_notifications/configure_outlook_notification_step4.png" alt="Copy Outlook recipe" %}}

#### 3.1 Configure which pentest should trigger notifications when findings get created

Select the Cobalt trigger at the top of the flow diagram, in order to select the already created Cobalt Connector you want to use. In the sidebar you will be able to select which pentest you want the recipe to listen for findings from. Choose whichever you want to configure the recipe for.
wolfgangbecker marked this conversation as resolved.
Show resolved Hide resolved

{{% image src="/integrations/integration_builder/findings_outlook_notifications/configure_outlook_notification_step5.png" alt="Configure Cobalt connection" %}}

#### 3.2 Configure which email address to send the to

Select "Send email from Outlook Mail" at the bottom of the flow diagram. At the top of the page choose "Connection" to select the previously created Outlook connection. Then provide an email in the "To" field. You can optionally customize To, BCC, Subject and Message, among others as needed.
wolfgangbecker marked this conversation as resolved.
Show resolved Hide resolved

{{% image src="/integrations/integration_builder/findings_outlook_notifications/configure_outlook_notification_step6.png" alt="Configure Outlook connection" %}}

Once ready, click "Save" at the top-right of the page.

{{% image src="/integrations/integration_builder/findings_outlook_notifications/configure_outlook_notification_step7.png" alt="Save recipe" %}}

### 4. Start the recipe

After saving the recipe, select "Start recipe" at the top of the page. This may take a few seconds.

{{% image src="/integrations/integration_builder/findings_outlook_notifications/start_recipe.png" alt="Start recipe" %}}

Once the recipe is running, you will see the jobs tab to monitor any events. This can be left open to verify whether a created finding triggers the desired notification.
The recipe will continue running even when closing the tab, until "Stop recipe" gets clicked.
wolfgangbecker marked this conversation as resolved.
Show resolved Hide resolved

{{% image src="/integrations/integration_builder/findings_outlook_notifications/running_recipe.png" alt="Running recipe" %}}

Check [Create Test Finding](/integrations/development/create-test-finding/) to test the recipe.
18 changes: 9 additions & 9 deletions content/en/Integrations/IntegrationBuilder/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,48 @@
---
title: "Troubleshooting"
linkTitle: "Troubleshooting"
weight: 40
weight: 50
---

## How to troubleshoot errors

To tell at a glance if your integration is failing, you can check your dashboard. Failures will be listed there.

![Dashboard with errors](/integrations/integration_builder/troubleshooting/how_to_troubleshoot/dashboard_with_error.png "Dashboard with error")
{{% image src="/integrations/integration_builder/troubleshooting/how_to_troubleshoot/dashboard_with_error.png" alt="Dashboard with errors" %}}

To tell which recipe is failing, you can scroll down on the dashboard page.

![Recipe run list](/integrations/integration_builder/troubleshooting/how_to_troubleshoot/recipe_run_list.png "Recipe run list")
{{% image src="/integrations/integration_builder/troubleshooting/how_to_troubleshoot/recipe_run_list.png" alt="Recipe run list" %}}

Once you have identified the failing recipe, navigate to the jobs page for the recipe. You can then click on the job that has failed to see why it failed.

![Failing recipe](/integrations/integration_builder/troubleshooting/how_to_troubleshoot/failing_recipe.png "Failing recipe")
{{% image src="/integrations/integration_builder/troubleshooting/how_to_troubleshoot/failing_recipe.png" alt="Failing recipe" %}}

Within the view for the failed job, you can click on the action that failed. This will show you the error message that describes why the failure occurred.

![Recipe action error](/integrations/integration_builder/troubleshooting/how_to_troubleshoot/action_error.png "Recipe action error")
{{% image src="/integrations/integration_builder/troubleshooting/how_to_troubleshoot/action_error.png" alt="Recipe action error" %}}

If you are unsure about how to fix the issue, you can view the input and debug tabs for the failing action to aquire more information that may be helpful for troubleshooting the issue.
If you are unsure about how to fix the issue, you can view the input and debug tabs for the failing action to acquire more information that may be helpful for troubleshooting the issue.
You may need to re-read your recipe to make sure the logic still makes sense.
If you think the failure is being caused by an issue with the Integration Builder or the Cobalt public API, please reach out to your CSM.

## How to rerun a failed recipe

If you need to re-run a failed recipe, you can navigate to the failed job then click the "Repeat this job" button.

![Rerun recipe](/integrations/integration_builder/troubleshooting/rerun_recipe.png "Rerun recipe")
{{% image src="/integrations/integration_builder/troubleshooting/rerun_recipe.png" alt="Rerun recipe" %}}

## How to revert a change to a recipe

If you make a change to your recipe that causes failures, you can easily revert to a previous version of the recipe.

To see the available versions of your recipe, navigate to the "versions" tab for your recipe.

![Recipe versions list](/integrations/integration_builder/troubleshooting/revert_recipe_change/recipe_versions.png "Recipe versions list")
{{% image src="/integrations/integration_builder/troubleshooting/revert_recipe_change/recipe_versions.png" alt="Recipe versions list" %}}

Next, click on the last-known working version of the recipe and click "Restore this version"

![Restore recipe version](/integrations/integration_builder/troubleshooting/revert_recipe_change/restore_recipe_version.png "Restore recipe version")
{{% image src="/integrations/integration_builder/troubleshooting/revert_recipe_change/restore_recipe_version.png" alt="Restore recipe version" %}}

You can now click "Start recipe" to start the restored version of your recipe.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.