Skip to main content
Skip table of contents



In cybersecurity, an Artifact can be a particular trace of information extracted from an event or incident left behind from cyber activity. For example, an artifact that can be extracted from a network traffic event may be endpoint IP addresses. We refer to information such as the endpoint IP as an artifact entity. D3 SOAR maps raw source data to over 100 of our data model fields in order to create artifact entities, extracting relevant details and drawing relationships between artifact types. When we extract several similar artifact entities, we can categorize these together as an artifact type.

D3 SOAR has two types of artifacts:

There are 13 built-in artifact types that come out-of-the-box. In addition, SOC teams can create their own custom artifact types in the Configuration module to enhance their security automation by defining artifact identity, role, relationships and conditions that allow the system to auto-detect and extract source-specific artifacts.
This document outlines all the information you will need to know about configuring custom D3 SOAR Artifacts and how to configure them.

UI Structure

The Artifacts’ UI contains the following components:

All Relationships

A button to show all artifact type relationships, where you can:

Add relationships

Delete relationships

View all Artifact relationships

Custom Artifact Type List

Sorted alphabetically, the list allows you to:

Search for an Artifact Type

Add new custom Artifact Type

Custom Artifact Type Detail

Allows you to customize the elements of a custom Artifact Type including:

Identity Fields

  • General Identity Fields

    • Add, edit and delete data model fields and roles

  • Source Specific Fields

    • View Event Field-Mapping source specific identify fields, and their integration and event source

Additional Fields

  • Add and delete additional fields specified for this Artifact Type


  • Add or delete relationships between two Artifacts


Built-In Artifact Types

D3 offers users 13 out-of-the-box, built-in system Artifact Types. Below is a chart of them and the required data model field for artifact creation. If you want to create a new artifact in an event or incident, you need to satisfy these minimum requirements:

Built-in artifact type:

Data Model Requirement:

Internal Endpoint

One of:




External Endpoint

One of:







Requires one of:








Email Address





Both of:










Both of:




Both of:



These cannot be edited or removed. All built-in artifact types have a blue icon for identification.

Custom Artifact Types

In addition to the built-in artifact types offered by D3, you also have the power to create custom artifact types to fit your needs. Custom Artifact Types will have user-defined identities, additional fields and relationships, allowing SOC teams to have greater flexibility in artifact detection and organization.

All custom Artifact Types are comprised of 4 elements:

  1. Header—Change the icon and view the Artifact Type name. All custom Artifact Types use an orange icon to differentiate it from built-in Artifact Types.

  2. Identity Field—Data model fields that identify artifact entities.

  3. Additional Fields—Supplementary data fields that relate to this Artifact Type.

  4. Relationships—View and Add to a list of relationships for this Artifact Type.

Identity Fields

An Identity Field is a specific data model field that defines an artifact's primary characteristic. In other words, when creating a custom artifact, you will need to specify which D3 data model field accurately represents the artifact type.

A data model field can only be used once per artifact type. For example, if a Data Model Field is already being used as an identity field, it cannot also be used as an additional field. The exception to this rule is that a source specific identity field can share the same data model field as a general identity field. In this case, two artifact entities will be extracted, one for the general identity and another for the source specific.

Reader Note

If the same data model field is used in two different artifact types, an event or incident will generate two artifact entities, one for each type.

There are two types of identity fields:

  1. General — Creates artifacts from all ingested data, regardless of integration or method of ingestion.

  2. Source specific — Creates artifacts that are ingested through a specific Integration and Event Source.

Reader Note

Only general identity fields can be created in artifact configuration. Source specific identity fields must be created within the event intake field-mapping of a specific integration and event source.

General Identity Fields

The General Identity Fields apply to all ingested data, regardless of integration and event source. You must determine at least one Data Model Field that represents this artifact type. Data model fields can be edited and changed for each integration under event-field mapping. Furthermore, as best practice, you should assign a Role to the selected data model field that explains the role it plays within this artifact type. The role should describe the artifact entity in artifact behaviour and artifact relationships. If no specific role is assigned, then the role will be the defaulted to the artifact type name.

  1. Add a new general identity field

  2. Data Model Field—This column shows a list of data model fields that have been selected, which serve as the current identity fields of this artifact type.

  3. Role—This column shows the corresponding roles to the data model field. You can filter the identity field by roles.

Source Specific Fields

The Source Specific fields are identity fields that create artifact entities only when the data is ingested through a specific integration and event source. Source specific fields can only be created and edited through an integration’s Event Field Mapping. The list of source specific fields shows an overview of all source specific mapping in this artifact type. If you wish to make changes, the redirect icon will take you to the specific integration and event intake.

  1. Data Model Field—The data model field that was specified in event field mapping. This field will be used for the creation of artifact entities of this type.

  2. Role—The reader-friendly role assigned to this data model field

  3. Integration—The name of the Integration that is this identity field’s source

  4. Event Source—The specific event source inside of the integration that the identity field belongs to

  5. Redirect—This icon redirects you to the specific integration and event source for this artifact identity field

Additional Fields

Additional Fields are supplementary information for this artifact type. They are not used to identify artifact entities but serve as extra fields that describe an artifact. The only parameter needed for an additional field is a valid data model field.

  1. Add additional fields. This is a multi-select batch-add action, and you can select several data model fields at once.

  2. Data Model Field—This is a list of the data model fields that are serving as additional fields for this artifact type

The ? icon provides a brief description of Additional Fields.


All relationships between artifacts can be viewed by clicking the button above the search or inside specific custom artifact type configurations.d

Relationships can be drawn between any two Artifact Types, with the option of specifying a Role for either of the two artifact types. There is an additional option to add a source condition for the relationship. The source condition ensures that this relationship will only be created between artifact entities that also satisfy the specified Integration (and Event Source).

Add New Relationship button—Create a new relationship between two artifact types

Artifact 1—Assign the first Artifact in the relationship. The Artifact Type is required, but a Role is optional.

Rader Note

If a Role is not assigned, the relationship will be created with every Role in that Artifact Type.

  1. Artifact 2—Assign the second Artifact in the relationship. The artifact type is required but a Role is not.

  2. Relationship Type Name—Select a relationship name from the dropdown or create your own. Names can be reused, so it is a good idea to create commonly used ones.

  3. (Optional) Source Conditions—Specify an Integration and event source that data must be ingested through in order for this relationship to be made.

  4. Relationship Type Name—The name assigned to a relationship. There are several system-defined relationship types, but you can also create your own. These can be reused as many times as you’d like, and the table can be sorted according to the name.

  5. Artifact 1—The first artifact type in the relationship. This will be assigned based on the order in creation. This must contain an artifact type but is not required to have a role.

  6. Artifact 2—The second artifact type in the relationship. This is also assigned based on the order in creation. It also must contain an artifact type but does not have to have a role.

  7. Integration—This is the Integration source condition parameter, indicating that only artifacts ingested through this Integration will be assigned this relationship.

  8. Event Source—Further details the source conditions under which this relationship is drawn. Only artifacts ingested through this event source will be assigned this relationship.

  9. Redirect—This icon redirects you to the specific Integration and Event Source for the source condition

Reader Note

Relationships can be made between two roles of the same artifact type. Additionally, relationships can be made between custom and built-in system artifact types.

Field Mapping

Source specific identity fields can be configured inside of event and incident field mapping, making it specific to an integration and event source. These must be created and edited within the event or incident field mapping.

In the overview of the event or incident intake command of an integration, there is an event field mapping section.

Click Setup Event Field Extraction Mapping and open the event field mapping window.

Clicking the add new field will open up the edit field pop-up, which prompts you to fill in the data model fields and its source, as well as the option to fill in the artifacts setting.

By filling the artifact settings, you specify the artifact type and role that an artifact entity will have when it is ingested through this integration and event source.

After configuring the artifact setting, the source specific identity field will appear inside of that artifact type. A redirect icon will allow you to go back to the integration and event source to edit the artifact type configuration.

Creating a Custom Artifact Type

Configuring a custom artifact type can be an integral part of building a full-feature cybersecurity automation platform. A SOC team may have integrations that generate events or incidents with artifact entities. These entities are often correlated with one another, and analysts may need to easily map their identity and/or relationships.

When monitoring a network traffic event, the event may have an internal IP address as an artifact. Thus, a potential use-case for custom artifact types is creating a custom internal IP address with relevant identity fields for network traffic events.

First, we will set up the artifact type by defining a data model field that identifies it. Then, we will set up a few additional fields that will provide supplementary information about the artifact type. And finally, we will assign a relationship between the internal IP address and an external IP address. After setting up the artifact type, we will also show what an event ingested artifact entity of a custom artifact type looks like.

  1. Create the custom type and call it Internal IP Address to demonstrate the use-case above.
    Navigate to Configurations > Artifacts. Click on the + button to create a new artifact type. Enter Internal IP Address and save. This cannot be changed to prevent duplicate artifact types. After clicking save, you should see an empty artifact type.

  1. One of the identifiers of an internal IP address is its source IP. In order to identify this type of internal IP address artifact, we need the data model field for a Source IP Address. This data model would therefore have the role of Source.

To add this identity field, click the + icon next to the identity fields header. Select the built-in D3 data model field Source IP address and give it the role Source. This ensures that any event with a source IP address will create an artifact entity of type internal IP address.

Reader Note

In the artifacts configuration page, you can only add new general identity fields. To add an identity field that receives data specific to an integration, do so in the Event Field Mapping inside of an integration’s event intake command.

  1. Some other details that you may want to know about an internal IP address are its source hostname and FQDN. However, these are not needed for generating the artifact entity, therefore we assign them as additional fields.
    Select these by clicking the + icon to the right of additional fields. You can batch add additional fields for convenience. Now, if a network traffic event is ingested, the artifact entity will be identified by its source IP and have additional information such as its hostname or FQDN.

  1. An internal IP address may have network traffic between an external IP address. In this case, we will assign a relationship between these artifact types.
    To configure the relationship, click the + icon. The first artifact type will be automatically filled in with internal IP address. Fill in the role source for this relationship. Select the second artifact type as the external IP address artifact type, with the role Destination. Then, name the relationship to Network connection from so that it can be labeled as the network flow from an internal IP to an external IP.

After setting everything up, your custom artifact should look like this:

Reader Note

Make sure the data model fields are set up in event intake field mapping. If needed, you can create custom data model fields to accommodate your cyber investigation.

  1. When an event is ingested, all of the details of this event can be seen in the event details page. Some of the event data will generate an artifact. For example, since we have artifact types internal IP and external IP address, this event should create two artifacts, one for each type.

  1. Click on the artifact behaviour tab. You will see that two IP artifacts have been ingested under custom artifact types. There is also a relationship between these two artifacts, showing that the network connection is from a source IP to a destination IP.

  1. Upon escalating an event into an incident, you will have access to further breakdown of the artifacts

Clicking into an artifact will open its details page.

a. This area shows the information about the artifact type and its name, as well as related additional details.

b. Click on the Export button to export this specific artifact entity in STIX 2.1 format.

c. Add any notes that may be important for describing this artifact.

  1. Navigate to the link analysis section of the incident workspace to see the artifacts in relation to different events and incidents, as well as any related artifacts that may also have been ingested.

View all artifacts that have been created during investigation in the Investigation Dashboard

  1. If there are artifact entities that were not created but need to be imported as a part of the investigation, manually upload them in the incident workspace. Click the + button on the top right corner of the artifacts section to upload an artifact.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.