Enrich key sales information with insights from your application (preview)

  • Article

Important

[This article is prerelease documentation and is subject to change.]

While sellers read and compose emails in Outlook, they can use Copilot for Sales to view key sales information about contacts, accounts, and opportunities that are related to the email. Key sales information is based on one of the following sources:

  • The opportunity that is connected to the email
  • The most relevant opportunity, based on the contacts and accounts in the email

You can extend the key sales information capability that Copilot for Sales provides with insights from your own application.

API description

You must add the following API description to the action. In this way, Copilot for Sales can identify the correct API that must be invoked to enrich the capability.

This action gets additional sales insights that will be shown in C4S key sales info card in outlook sidecar. The action enhances the existing skills of copilot for sales.

Input parameters

Copilot for Sales is designed to provide the following input parameters to your APIs.

Name Data type/format Required Details Description to add in the action
recordType String Yes The record type in customer relationship management (CRM). The record can specify the account, opportunity, lead, or contact that is related to the email. This input identifies the record type in CRM for which key sales info is requested.
recordId String Yes The record ID in CRM. This input provides the unique identifier of the CRM record for which key sales info is requested.
crmType String No The type of CRM system. The valid values are Salesforce and Dynamics 365. This input indicates the type of CRM in which the CRM record exists, for which key sales info is requested.
crmOrgUrl String No The CRM organization URL. This input indicates the URL of the CRM environment in which the CRM record exists, for which key sales info is requested.
top Integer No The number of insights to fetch. This input indicates the number of sales highlights to fetch.
skip Integer No The number of insights to skip. This input indicates the number of items to skip when fetching sales highlights.

Output parameters

Copilot for Sales expects to receive a list of insights (objects) from your APIs, and it expects each insight to have specific parameters. To ensure that Copilot for Sales can correctly parse the output, the response structure must adhere to the guidelines in the following table.

Parameter Data type Required Details
value Array Yes A list of insights (objects) that are defined as described in the Schema for insights section.
hasMoreResults Boolean No A value that indicates whether more results are available.

Schema for insights

Name Data type/format Required Details Description to add in the action
title String Yes The title of the sales insight citation card. It should include only the partner's name and can have up to 20 characters. This output indicates the title of citation card for the insight.
description String Yes The description of the sales insight. It's shown as a bullet point in the Key sales info pane and can have up to 130 characters. Here is an example: Validation: Next steps: Align with timeline and success criteria. This output indicates the text of the insight to be included in key sales info.
url String No A valid URL to open the insight in the partner application. This output indicates the URL to learn more about the insight.
dateTime DateTime No The date and time of the activity in UTC format. If the activity has both a start time and an end time, the application must determine which time to show. The format follows the OpenAPI specification. Here is an example: 2017-07-21T17:32:28Z. This output indicates the time associated with the insight.
additionalProperties An object that has Property Name and Property Value values of the String type No A set of name-value pairs that indicate additional properties of the related insight that the action returns. This information is shown in a pop-up card when users select insights in the Key sales info pane. This output indicates additional properties as name-value pairs of each related insight returned by the action.

Example

{
    "value": [
        {
            "title": "Contract signed",
            "description": "Kenny Smith sent Renewal Contract on 04/23/2023 related to 50 Cafe A-100 Automatic",
            "dateTime": "2023-09-07T03:42:35.4662309Z",
            "url": https://contosohub.com,
            "additionalProperties": {
                "Contract name": "Renewal contract for Fourth Coffee",
                "Signed by": "Alberto Burgos, Tony Benis",
                "Signed": "9/7/23",
                 "Related Opportunity": "50 CafeA-100 Automatic"
            }
        }
    ],
    "hasMoreResults": false
}

The example in the following image shows how the output of the API is mapped to the key sales information.

Screenshot showing insights from partner apps in key sales information.

Legend:

  1. Section that shows insights from the partner application. The section title is derived from the name of the Microsoft Power Platform connector.
  2. Descriptions of the insight from the API response.
  3. Citation numbers that can be selected to view details about the insight.
  4. Citation card that shows details about the insight.
  5. Icon and title of the insight. The icon is retrieved from the Microsoft Power Platform connector metadata. The title is the title of the insight from the API response.
  6. Additional properties of the insight from the API response.
  7. Name of the partner application. The name that is shown is the name of the Microsoft Power Platform connector.
  8. Link that can be selected to view insight details in the partner application. It's based on the URL of the insight in the API response.

See also

View key sales information in Copilot for Sales
Add new question and answer (Q&A) capabilities to the Sales chat
Enrich email summaries with insights from your application
Enrich CRM record details with insights from your application
Enrich CRM record summaries with insights from your application
Extend Microsoft 365 Copilot for Sales with partner applications
Build Copilot for Sales extensions