---
schema_version: "1"
id: d2c7359eddc8762966d03e3f433ed95fe1b3c5eef26ebb583aef73ef268394e5
title: Add a Custom Entity
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/service/264-0-0/bots_service_add_entity.md
canonical_url: https://help.salesforce.com/s/articleView?id=service.bots_service_add_entity.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: e4f271cbb329807345f8a32bb8116e5ab3798684ae122d3989374dbddaeb0c12
description: Create custom entities to gather information that matches a regex pattern or list of synonym values.
products:
  - Service Cloud
  - Service Intelligence
release: "264"
---
# Add a Custom Entity

Create custom entities to gather information that matches a regex pattern or list of synonym values.

### Required Editions

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small edition"><colgroup><col></colgroup><tbody><tr class=""><td class="slds-cell-wrap" style="vertical-align:top;"><a href="https://help.salesforce.com/s/articleView?id=service.einstein_service_intro.htm&amp;language=en_US" target="_blank">View supported editions</a>.</td></tr></tbody></table>

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small permission">
        <colgroup>
          <col style="width:50%">
          <col style="width:50%">
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="colgroup" class="slds-cell-wrap" colspan="2" style="text-align:center;vertical-align:top;" id="d6360e57">User Permissions Needed</th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="User Permissions Needed" class="slds-cell-wrap" style="vertical-align:top;" headers="d6360e57 ">To build and manage Einstein Bots:</td>

            <td class="slds-cell-wrap" style="vertical-align:top;" headers="d6360e57 ">
              <p>Customize Application</p>
              <p>OR</p>
              <p>Modify Metadata</p>
              <p>OR</p>
              <p style="margin-bottom:0;">Manage Bots</p>
            </td>

          </tr>
        </tbody>
      </table>

Custom entities have a data type of text. The bot can recognize an entity in customer input, extract the information, and save it to a variable. Custom entities support two methods of extraction: regex pattern or a list of values and synonyms. Entities can be shared across versions of the same bot.

1. From the Bot Builder menu, click **Entities**.
    
    ![Entities option in Bot Builder menu](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-service-support_intelligence-264-0-0-production-enus/dcd06a7b-b5ab-448b-a767-4e2e90481508/support_intelligence/images/bots/bots_service_builder_menu_entities.png)
2. In the Entities list view, click **New**.
3. Provide an entity name and description and select an extraction type for the entity.
    1. If the entity type is Pattern, optionally enter a regex pattern. If the entity represents something that follows a pattern, such as an order code or email address, you can use a regular expression to capture it from user input. For example, use the following regex to identify an email address in customer input: \\b\\w+@\[a-zA-Z\_\]+?\\.\[a-zA-Z\]{2,3}\\b
    2. If the entity type is Value List, see [Add a Value List Entity](https://help.salesforce.com/s/articleView?id=service.bots_service_add_entity_value_list.htm&release=264.0.0&type=5 "A value list entity provides a way to extract the entity if there’s an exact match to a value or a synonym in a list of values.").
4. Save the entity.