Skip to main content

Embedded Details in Case Descriptions

Learn how to embed details directly in case descriptions to spotlight critical case details.

Updated yesterday

Display custom field and observable details directly in a case description. Embedded mentions give high visibility of key details, without switching tabs or scrolling through the full case context.

Embed details manually in the case, or automatically through a workflow.

Add embedded details manually

  1. Go to Cases page: In your Cases page, open the desired case. Go to Description and click on the edit con.

  2. Embed mention: Use the following markdown structure to embed an observable or custom field:

    1. For observables, use [mention://observable/<observable_ID>]

    2. For custom fields, use [mention://custom_field/<field_name>]

  3. Save edits: Click outside the edit box to save your edits and display embedded objects in view.

Observables are displayed with an icon, value, type and reputation. Hover over the mention to view a preview, and click on it to link to the observable in the Observables page. Observables are colour-coded by severity.

If you update the custom field value in the custom field list, it will automatically update the mention in the description.

Add embedded details automatically

Add embedded observable or custom field mentions automatically in the following workflow steps in:

  • Create a case: Add the Case description optional parameter to the step, and enter the relevant mentions in the field.

  • Create a case from JSON: Include the relevant mentions in the case description when creating a case from a JSON payload.

  • Create a case from template: Add the Case description optional parameter to the step, and enter the relevant mentions in the field.

  • Change case description: Enter the relevant mentions in the Case description parameter.

Use the following structure in the Description field:

  • For observables, use [mention://observable/<observable_ID>]

  • For custom fields, use [mention://custom_field/<field_name>]

Did this answer your question?