> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/sublime-security.md).

# Sublime Security

Search and manage emails Sublime Security has flagged, reported or quarantined, review detection rules, and react to flagged-message and employee-report events.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector        | Authentication |
| ---------------- | -------------- |
| Sublime Security | API Key        |

### Sublime Security

Connect to Sublime Security to search flagged and reported emails, manage detection rules, and quarantine or restore messages.

#### Set up in Sublime Security

1. Prepare the Sublime Security account or service that the workflow will access. Grant access to the required resources and operations.
2. **Base URL:** Your Sublime Security deployment's Base URL, copied from Automate > API in the Sublime dashboard (the same page that shows your API key). Origin only (scheme + host, no path), e.g. '<https://platform.sublime.security>'.
3. **API Key:** Create an API key under Automate > API in the Sublime dashboard. It is shown exactly once at creation time; if lost, create a new one.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Sublime Security**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required                 | What to enter                                                                                                                                                                                                                                                                                |
| ------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Base URL      | Optional / as applicable | Your Sublime Security deployment's Base URL, copied from Automate > API in the Sublime dashboard (the same page that shows your API key). Origin only (scheme + host, no path), e.g. '<https://platform.sublime.security>'. [Provider instructions](https://docs.sublime.security/docs/api). |
| API Key       | Yes                      | Create an API key under Automate > API in the Sublime dashboard. It is shown exactly once at creation time; if lost, create a new one. [Provider instructions](https://docs.sublime.security/docs/api).                                                                                      |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Sublime Security** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Search Emails

Find emails Sublime has processed by sender, subject, mailbox, attachment or date range.

#### Inputs

| Field                 | Type            | Required | Description                                                                                        |
| --------------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------- |
| Search text           | string          | No       | Text to look for anywhere in the email (sender, subject, recipients).                              |
| From                  | string          | No       | Sender address to match. Wildcards are allowed.                                                    |
| Subject contains      | string          | No       | Words to match in the email subject.                                                               |
| Mailbox               | select (string) | No       | Only return emails delivered to this monitored mailbox. Options load from the selected connection. |
| Received after        | datetime        | No       | Only emails Sublime processed at or after this time.                                               |
| Received before       | datetime        | No       | Only emails Sublime processed before this time.                                                    |
| Maximum results       | integer         | No       | How many emails to return at most. Minimum: 1. Default: 50.                                        |
| Show advanced filters | boolean         | No       | Reveal recipient, attachment, message-id and resume-offset filters. Default: false.                |
| Recipient             | string          | No       | Match an address in the To, CC or BCC fields.                                                      |
| Attachment SHA256     | string          | No       | Find every email carrying this exact attachment.                                                   |
| Attachment filename   | string          | No       | Match attachment filenames. Wildcards are allowed.                                                 |
| Message-ID header     | string          | No       | Match the email's Message-ID header, useful when another tool gave you one.                        |
| Start at result       | integer         | No       | Skip this many results, to continue a previous search. Minimum: 0. Default: 0.                     |

#### Outputs

| Field                | Type          | Description                                                   |
| -------------------- | ------------- | ------------------------------------------------------------- |
| Emails               | object\_array | The matching emails, grouped by identical content.            |
| Total matches        | integer       | How many emails match the filters in total.                   |
| Total is approximate | boolean       | True when the total shown is a lower bound rather than exact. |
| Next offset          | integer       | Pass this back as the start offset to get the next page.      |

### Get Email Details

Open one email to see who received it, which detection rules flagged it, and whether anyone reported it.

#### Inputs

| Field          | Type   | Required | Description                                                         |
| -------------- | ------ | -------- | ------------------------------------------------------------------- |
| Email group ID | string | Yes      | The ID of the email group, taken from a search result or a trigger. |

#### Outputs

| Field                           | Type          | Description                                                              |
| ------------------------------- | ------------- | ------------------------------------------------------------------------ |
| Email group ID                  | string        | The canonical ID of this email group.                                    |
| Current state                   | string        | Where the email currently sits, for example delivered or quarantined.    |
| Classification                  | string        | How the email was classified, for example malicious or benign.           |
| Review status                   | string        | Whether an analyst has reviewed this email.                              |
| Analyst verdict                 | string        | The verdict the analyst recorded, for example malicious or benign.       |
| Analyst note                    | string        | The note the analyst left with their review.                             |
| Copies delivered                | object\_array | Each copy of the email, with its mailbox, recipients and delivery state. |
| Detection rules that flagged it | object\_array | The detection rules that matched this email.                             |
| Employee reports                | object\_array | Reports employees filed about this email.                                |
| Links clicked                   | object\_array | Links in the email that recipients actually clicked.                     |

### List Mailboxes

See which mailboxes Sublime is monitoring and whether any have a broken connection.

#### Inputs

| Field                 | Type    | Required | Description                                                                       |
| --------------------- | ------- | -------- | --------------------------------------------------------------------------------- |
| Search                | string  | No       | Filter by mailbox name or email address.                                          |
| Only active mailboxes | boolean | No       | Hide mailboxes that are not currently being monitored. Default: true.             |
| Maximum results       | integer | No       | How many mailboxes to return at most. Minimum: 1. Default: 100.                   |
| Start at result       | integer | No       | Skip this many mailboxes, to continue a previous listing. Minimum: 0. Default: 0. |

#### Outputs

| Field            | Type          | Description                                                |
| ---------------- | ------------- | ---------------------------------------------------------- |
| Mailboxes        | object\_array | The monitored mailboxes.                                   |
| Total mailboxes  | integer       | How many mailboxes match in total.                         |
| Active mailboxes | integer       | How many of the matching mailboxes are actively monitored. |
| Next offset      | integer       | Pass this back as the start offset to get the next page.   |

### List Detection Rules

See the detection rules in this Sublime account and which of them are switched on.

#### Inputs

| Field           | Type            | Required | Description                                                                                                                                                                      |
| --------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Search          | string          | No       | Filter rules by keyword.                                                                                                                                                         |
| Rule origin     | select (string) | No       | Show all rules, only rules from a subscribed feed, or only rules written in this account. Available values: Any, From a subscribed feed, Authored in this account. Default: any. |
| Maximum results | integer         | No       | How many rules to return at most. Minimum: 1. Default: 100.                                                                                                                      |
| Start at result | integer         | No       | Skip this many rules, to continue a previous listing. Minimum: 0. Default: 0.                                                                                                    |

#### Outputs

| Field           | Type          | Description                                              |
| --------------- | ------------- | -------------------------------------------------------- |
| Detection rules | object\_array | The detection rules that matched.                        |
| Total rules     | integer       | How many rules match in total.                           |
| Next offset     | integer       | Pass this back as the start offset to get the next page. |

### Get Detection Rule

Read one detection rule in full, including its logic, severity and known false positives.

#### Inputs

| Field          | Type            | Required | Description                                                            |
| -------------- | --------------- | -------- | ---------------------------------------------------------------------- |
| Detection rule | select (string) | Yes      | The detection rule to read. Options load from the selected connection. |

#### Outputs

| Field                  | Type          | Description                                                       |
| ---------------------- | ------------- | ----------------------------------------------------------------- |
| Rule ID                | string        | The rule's ID.                                                    |
| Name                   | string        | The rule's name.                                                  |
| Description            | string        | What the rule detects.                                            |
| Severity               | string        | How serious a match is.                                           |
| Active                 | boolean       | Whether the rule is currently switched on.                        |
| Rule logic (MQL)       | string        | The rule's detection logic.                                       |
| Tags                   | string\_array | Labels grouping this rule with similar ones.                      |
| Known false positives  | string\_array | Cases the rule's author expects to match harmlessly.              |
| Attack types           | string\_array | The kinds of attack this rule looks for.                          |
| Tactics and techniques | string\_array | The attacker tactics and techniques this rule covers.             |
| Detection methods      | string\_array | How the rule detects a match, for example header or URL analysis. |
| Automated action IDs   | string\_array | The automated actions Sublime runs when this rule matches.        |

### Activate or Deactivate Detection Rule

Switch a detection rule on or off, for example to silence a rule that is producing false positives.

#### Inputs

| Field          | Type            | Required | Description                                                                        |
| -------------- | --------------- | -------- | ---------------------------------------------------------------------------------- |
| Detection rule | select (string) | Yes      | The detection rule to switch on or off. Options load from the selected connection. |
| Rule enabled   | boolean         | Yes      | On to have the rule evaluate incoming email, off to silence it.                    |

#### Outputs

| Field          | Type    | Description                                        |
| -------------- | ------- | -------------------------------------------------- |
| Rule ID        | string  | The rule's ID.                                     |
| Name           | string  | The rule's name.                                   |
| Active         | boolean | Whether the rule is switched on after this change. |
| Severity       | string  | How serious a match is.                            |
| Last activated | string  | When the rule was last switched on.                |

### Quarantine Emails

Pull malicious emails out of every recipient's inbox and hold them in quarantine.

#### Inputs

| Field           | Type            | Required | Description                                                                                                                                                                                                   |
| --------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Email group IDs | string          | Yes      | The emails to quarantine, as one ID or several separated by commas.                                                                                                                                           |
| Classification  | select (string) | No       | Why the email is being quarantined. Recorded on the review for reporting. Available values: Malicious, Benign, Spam, Graymail, Simulation, Unwanted, Violation, Non-violation.                                |
| Report label    | select (string) | No       | Label sent back to Sublime's detection feedback, if you want to report this email. Available values: Spam, Phishing, False positive, False negative, Phishing simulation, Graymail, Violation, Non-violation. |
| Note            | textarea        | No       | A note for the audit trail, for example the ticket that triggered this.                                                                                                                                       |

#### Outputs

| Field              | Type   | Description                                                   |
| ------------------ | ------ | ------------------------------------------------------------- |
| Task ID            | string | The ID of the quarantine job Sublime ran.                     |
| Result             | string | Whether the quarantine finished, is still running, or failed. |
| Error              | string | Why the quarantine failed, when it did.                       |
| Emails quarantined | string | The email groups this request covered.                        |

### Restore Quarantined Emails

Put quarantined emails back into the recipients' inboxes, for example after a false positive.

#### Inputs

| Field           | Type            | Required | Description                                                                                                                                                                                                   |
| --------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Email group IDs | string          | Yes      | The emails to restore, as one ID or several separated by commas.                                                                                                                                              |
| Classification  | select (string) | No       | Why the email is being restored. Recorded on the review for reporting. Available values: Malicious, Benign, Spam, Graymail, Simulation, Unwanted, Violation, Non-violation.                                   |
| Report label    | select (string) | No       | Label sent back to Sublime's detection feedback, if you want to report this email. Available values: Spam, Phishing, False positive, False negative, Phishing simulation, Graymail, Violation, Non-violation. |
| Note            | textarea        | No       | A note for the audit trail explaining the restore.                                                                                                                                                            |

#### Outputs

| Field           | Type   | Description                                                |
| --------------- | ------ | ---------------------------------------------------------- |
| Task ID         | string | The ID of the restore job Sublime ran.                     |
| Result          | string | Whether the restore finished, is still running, or failed. |
| Error           | string | Why the restore failed, when it did.                       |
| Emails restored | string | The email groups this request covered.                     |

### Hunt Emails with a Query

Sweep past email with a Sublime detection query to find everything matching a threat.

#### Inputs

| Field                 | Type     | Required | Description                                                                |
| --------------------- | -------- | -------- | -------------------------------------------------------------------------- |
| Detection query (MQL) | textarea | Yes      | The Sublime detection query to run against past email.                     |
| Hunt from             | datetime | Yes      | Start of the period to hunt across.                                        |
| Hunt until            | datetime | Yes      | End of the period to hunt across.                                          |
| Show advanced options | boolean  | No       | Reveal the hunt name and resume-offset fields. Default: false.             |
| Hunt name             | string   | No       | A label so you can recognise this hunt in Sublime later.                   |
| Maximum results       | integer  | No       | How many matching emails to return at most. Minimum: 1. Default: 50.       |
| Start at result       | integer  | No       | Skip this many results, to continue paging a hunt. Minimum: 0. Default: 0. |

#### Outputs

| Field             | Type          | Description                                                           |
| ----------------- | ------------- | --------------------------------------------------------------------- |
| Hunt ID           | string        | The ID of the hunt Sublime ran.                                       |
| Status            | string        | Whether the hunt finished, is still running, or failed.               |
| Matching emails   | object\_array | The emails the query matched.                                         |
| Total matches     | integer       | How many emails the hunt matched.                                     |
| Results truncated | boolean       | True when Sublime stopped collecting matches, so results are partial. |
| Error             | string        | Why the hunt failed, when it did.                                     |
| Next offset       | integer       | Pass this back as the start offset to get more matches.               |

### Analyze an Email

Run Sublime's detection rules against an email you supply and see what it would flag.

#### Inputs

| Field              | Type            | Required | Description                                                                                                                             |
| ------------------ | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| Raw email          | textarea        | Yes      | The full email including its headers, as .eml text.                                                                                     |
| Rules to run       | select (string) | No       | Run only the rules that are switched on, or every rule in the account. Available values: Active rules only, All rules. Default: active. |
| Ad-hoc query (MQL) | textarea        | No       | An extra detection query to evaluate against this email.                                                                                |

#### Outputs

| Field                | Type          | Description                                           |
| -------------------- | ------------- | ----------------------------------------------------- |
| Rules that matched   | object\_array | The detection rules this email triggered.             |
| All rule results     | object\_array | Every rule that was evaluated and whether it matched. |
| Ad-hoc query results | object\_array | The outcome of the extra query, if you supplied one.  |
| Rules matched        | integer       | How many detection rules the email triggered.         |

## Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

### New Flagged Email

Starts the workflow when Sublime flags a new email, optionally filtered by severity, verdict or mailbox.

No setup beyond the connection is required. Optionally narrow which flagged emails fire the trigger by severity, attack score verdict, mailbox, or unreviewed status.

#### Configuration

| Field                  | Type                      | Required | Description                                                                                                                                   |
| ---------------------- | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| Severities             | multiple\_select (string) | No       | Only fire for emails flagged by rules of these severities. Leave empty for all. Available values: Informational, Low, Medium, High, Critical. |
| Attack score verdicts  | multiple\_select (string) | No       | Only fire for emails Sublime scored with these verdicts. Available values: Unknown, Likely benign, Suspicious, Malicious, Graymail, Spam.     |
| Mailbox                | select (string)           | No       | Only watch this mailbox. Leave empty to watch every monitored mailbox. Options load from the selected connection.                             |
| Only unreviewed emails | boolean                   | No       | Skip emails an analyst has already reviewed in Sublime. Default: false.                                                                       |

#### Event inputs

| Field                           | Type          | Required | Description                                                           |
| ------------------------------- | ------------- | -------- | --------------------------------------------------------------------- |
| Email group ID                  | string        | Yes      | The canonical ID of the flagged email. Default: .                     |
| Subject                         | string        | No       | The email's subject.                                                  |
| From                            | string        | No       | Who sent the email.                                                   |
| Mailbox                         | string        | No       | The mailbox that received it.                                         |
| State                           | string        | No       | Where the email currently sits, for example delivered or quarantined. |
| Detection rules that flagged it | object\_array | No       | The rules that matched this email. Default: \[].                      |
| Received at                     | string        | No       | When Sublime processed the email.                                     |

#### Outputs

| Field                           | Type          | Description                                                           |
| ------------------------------- | ------------- | --------------------------------------------------------------------- |
| Email group ID                  | string        | The canonical ID of the flagged email.                                |
| Subject                         | string        | The email's subject.                                                  |
| From                            | string        | Who sent the email.                                                   |
| Mailbox                         | string        | The mailbox that received it.                                         |
| State                           | string        | Where the email currently sits, for example delivered or quarantined. |
| Detection rules that flagged it | object\_array | The rules that matched this email.                                    |
| Received at                     | string        | When Sublime processed the email.                                     |

### New Employee Report

Starts the workflow when an employee reports a suspicious email to Sublime.

No setup beyond the connection is required, as long as employees have a way to report suspicious emails to Sublime (for example the reporting add-in).

#### Event inputs

| Field                | Type   | Required | Description                                                       |
| -------------------- | ------ | -------- | ----------------------------------------------------------------- |
| Email group ID       | string | Yes      | The canonical ID of the reported email. Default: .                |
| Reported by          | string | No       | Who reported the email.                                           |
| Reported via         | string | No       | How the report reached Sublime, for example the reporting add-in. |
| Reported at          | string | No       | When the report was filed.                                        |
| Reporting message ID | string | No       | The ID of the message the report came from.                       |

#### Outputs

| Field                | Type   | Description                                                       |
| -------------------- | ------ | ----------------------------------------------------------------- |
| Email group ID       | string | The canonical ID of the reported email.                           |
| Reported by          | string | Who reported the email.                                           |
| Reported via         | string | How the report reached Sublime, for example the reporting add-in. |
| Reported at          | string | When the report was filed.                                        |
| Reporting message ID | string | The ID of the message the report came from.                       |

### Sublime Event (Webhook)

Starts the workflow the moment a Sublime rule or automation fires, including which automated actions ran. Requires a webhook Action configured in the Sublime dashboard pointing at this trigger's URL, with its signing secret pasted below.

1. In Sublime, go to Automate > Actions and create (or open) a Webhook action. 2. Paste this trigger's URL as the Action's endpoint: {{webhook\_url}} 3. Click 'Click to reveal' on the Action's signing secret and paste it into 'Webhook signing secret' below; every delivery is rejected without it. 4. Attach the Action to the detection rules or automations that should start this workflow, then save.

#### Configuration

| Field                  | Type                      | Required | Description                                                                                                                                        |
| ---------------------- | ------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| Webhook signing secret | secret                    | Yes      | The signing secret Sublime shows for this webhook Action. Open Sublime, go to the Action, and use Click to reveal.                                 |
| Event types            | multiple\_select (string) | No       | Only run for these kinds of event. Leave empty for all of them. Available values: Message flagged, Group (related message flagged), Manual action. |

#### Event inputs

| Field                           | Type          | Required | Description                                                                           |
| ------------------------------- | ------------- | -------- | ------------------------------------------------------------------------------------- |
| Event ID                        | string        | Yes      | The ID Sublime gave this event. Default: .                                            |
| Event type                      | string        | Yes      | What kind of event this is. Default: .                                                |
| Email group ID                  | string        | No       | The canonical ID of the email the event is about.                                     |
| Message ID                      | string        | No       | The ID of the specific email copy involved.                                           |
| Mailbox ID                      | string        | No       | The mailbox that received the email.                                                  |
| Detection rules that flagged it | object\_array | No       | The rules that matched, with their severity. Default: \[].                            |
| Automated actions taken         | object\_array | No       | What Sublime automatically did about the email, for example auto-trash. Default: \[]. |
| Event time                      | string        | No       | When the event happened.                                                              |

#### Outputs

| Field                           | Type          | Description                                                             |
| ------------------------------- | ------------- | ----------------------------------------------------------------------- |
| Event ID                        | string        | The ID Sublime gave this event.                                         |
| Event type                      | string        | What kind of event this is.                                             |
| Email group ID                  | string        | The canonical ID of the email the event is about.                       |
| Message ID                      | string        | The ID of the specific email copy involved.                             |
| Mailbox ID                      | string        | The mailbox that received the email.                                    |
| Detection rules that flagged it | object\_array | The rules that matched, with their severity.                            |
| Automated actions taken         | object\_array | What Sublime automatically did about the email, for example auto-trash. |
| Event time                      | string        | When the event happened.                                                |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/sublime-security.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
