Connectors Reference

Dynamics 365 Sales Insights

Dynamics 365 Sales Insights helps increase your sales with the help of AI-driven insights that promote personalized engagement and proactive decision making to help build relationships.

 

Status: Production

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

CreateActionCard (string organization, [advanced][Optional]string actiontype, [advanced][Optional]string regardingobjecttype, CreateActionCardParameterBody body)

Create card for assistant

CreateActionCard_V2 (string organization, string cardname, string title, string description, string actionname, string actiontype, CreateActionCard_V2ParameterBody body, [advanced][Optional]string postoperation, [advanced][Optional]string secondaryactionname, [advanced][Optional]string secondaryactiontype, [advanced][Optional]string secondarypostoperation, [advanced][Optional]string regardingobjecttype, [advanced][Optional]string regardingobjectid, [advanced][Optional]string ownerid, [advanced][Optional]string startdate, [advanced][Optional]string expirydate)

Create card for assistant V2

CreateActionCard_V3 (string organization, BodyFieldsForCreateActionCardV3 body, string actiontype, [advanced][Optional]string secondaryactiontype, [advanced][Optional]string regardingobjecttype, [advanced][Optional]string regardingobjectid, [advanced][Optional]string ownerid, [advanced][Optional]string startdate, [advanced][Optional]string expirydate)

Create card for assistant V3

GetCrmOrganizationList ()

Get CRM organization list

GetEligibleRegardingEntities (string organization)

Get entity list

GetCrmEntityList (string organization)

Get entity list

CreateCustomActionDefinition (string organization, string entityname, string customaction, CreateCustomActionDefinitionParameterBody body)

Choose custom action (CRM process) for insight card

GetActionTypes ()

Get action types list

GetActionTypesV2 ()

Get action types v2 list

GetPostOperations ()

Get post operations list

GetEntityListForCustomAction (string organization)

Get entity list for custom action

GetDynamicFieldsForActionType (string organization, string actiontype, [Optional]string secondaryactiontype, [Optional]string version)

Get dynamic fields for action type

GetCustomActionParameters (string organization, string customaction)

Get parameters for custom action

GetCustomActionList (string organization, string entityname)

Get custom actions list

GetPlaybookTemplates (string organization)

Get playbook templates list

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

ActionTypes

 

ActionTypesList

 

BodyFieldsForCreateActionCardV3

 

CreateActionCardParameterBody

 

CreateActionCardResponse

 

CreateActionCard_V2ParameterBody

 

CreateActionCard_V2Response

 

CreateActionCard_V3Response

 

CreateCustomActionDefinitionParameterBody

 

CustomAction

 

CustomActionList

 

Entity

 

EntityList

 

Object

 

Organization

 

OrganizationsList

 

PlaybookTemplate

 

PlaybookTemplatesList

 

PostOperation

 

PostOperationsList

 

 

Actions:

CreateActionCard

Summary: Create card for assistant

Description: Create Card for Sales Assistant.

 

Syntax:

Dynamics365SalesInsights.CreateActionCard (string organization, [advanced][Optional]string actiontype, [advanced][Optional]string regardingobjecttype, CreateActionCardParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

organization

string

(Environment (org))

Choose the Dynamics 365 environment (org) in which you want to create the insight card.

True

GetCrmOrganizationList

actiontype

string

(Button entity)

Choose the entity if button type is Open Entity.

False

GetCrmEntityList

regardingobjecttype

string

(Display entity)

Choose the entity where this card should be shown.

False

GetCrmEntityList

body

CreateActionCardParameterBody

 

 

True

 

Returns:

          Type:CreateActionCardResponse

 

CreateActionCard_V2

Summary: Create card for assistant V2

Description: Create Card for Sales Assistant.

 

Syntax:

Dynamics365SalesInsights.CreateActionCard_V2 (string organization, string cardname, string title, string description, string actionname, string actiontype, CreateActionCard_V2ParameterBody body, [advanced][Optional]string postoperation, [advanced][Optional]string secondaryactionname, [advanced][Optional]string secondaryactiontype, [advanced][Optional]string secondarypostoperation, [advanced][Optional]string regardingobjecttype, [advanced][Optional]string regardingobjectid, [advanced][Optional]string ownerid, [advanced][Optional]string startdate, [advanced][Optional]string expirydate)

 

Parameters:

Name

Type

Summary

Required

Related Action

organization

string

(Environment (org))

Choose the Dynamics 365 environment (org) in which you want to create the insight card.

True

GetCrmOrganizationList

cardname

string

(Card name)

Simple text only (no dynamic content or expressions). Card name is shown in the insight card list and at the top of the card.

True

title

string

(Card header)

Enter a title to appear in the card header.

True

description

string

(Card text)

Enter text for the body of the insight card.

True

actionname

string

(Primary action text)

Enter the text that should appear on the button (for example: open email)

True

actiontype

string

(Primary action type)

Choose an action type.

True

GetActionTypes

body

CreateActionCard_V2ParameterBody

 

 

True

postoperation

string

(Card behavior after primary action click)

Choose whether the card should be dismissed, snoozed, or should persist after the button is clicked. Default is persist.

False

GetPostOperations

secondaryactionname

string

(Secondary action text)

Enter the text that should appear on the button (for example: open email)

False

secondaryactiontype

string

(Secondary action type)

Choose an action type.

False

GetActionTypesV2

secondarypostoperation

string

(Card behavior after secondary action click)

Choose whether the card should be dismissed, snoozed, or should persist after the button is clicked. Default is persist.

False

GetPostOperations

regardingobjecttype

string

(Display entity)

Choose the entity where this card should be shown.

False

GetEligibleRegardingEntities

regardingobjectid

string(uuid)

(Display record ID)

Enter the dynamic value with the record ID for the display entity.

False

ownerid

string(uuid)

(Show for)

Enter a dynamic value to define who should see this card (usually "Owner").

False

startdate

string(date-time)

(Show from)

Set how long after a card is generated it should be shown. Default is immediate - utcNow(). (UTC format: yyyy-MM-ddTHH:mm:ssZ)

False

expirydate

string(date-time)

(Show until)

Set how long after a card is generated it should expire. Default is 24 hours - utcNow().addHours(24). (UTC format: yyyy-MM-ddTHH:mm:ssZ)

False

 

Returns:

          Type:CreateActionCard_V2Response

 

CreateActionCard_V3

Summary: Create card for assistant V3

Description: Create Card for Sales Assistant.

 

Syntax:

Dynamics365SalesInsights.CreateActionCard_V3 (string organization, BodyFieldsForCreateActionCardV3 body, string actiontype, [advanced][Optional]string secondaryactiontype, [advanced][Optional]string regardingobjecttype, [advanced][Optional]string regardingobjectid, [advanced][Optional]string ownerid, [advanced][Optional]string startdate, [advanced][Optional]string expirydate)

 

Parameters:

Name

Type

Summary

Required

Related Action

organization

string

(Environment (org))

Choose the Dynamics 365 environment (org) in which you want to create the insight card.

True

GetCrmOrganizationList

body

BodyFieldsForCreateActionCardV3

 

Describes the fields for CreateActionCard_V3

True

actiontype

string

(Primary action type)

Choose an action type.

True

GetActionTypesV2

secondaryactiontype

string

(Secondary action type)

Choose an action type. Ensure Primary action type is not None.

False

GetActionTypesV2

regardingobjecttype

string

(Display entity)

Choose the entity where this card should be shown.

False

GetEligibleRegardingEntities

regardingobjectid

string(uuid)

(Display record ID)

Enter the dynamic value with the record ID for the display entity.

False

ownerid

string(uuid)

(Show for)

Enter a dynamic value to define who should see this card (usually "Owner").

False

startdate

string(date-time)

(Show from)

Set how long after a card is generated it should be shown. Default is immediate - utcNow(). (UTC format: yyyy-MM-ddTHH:mm:ssZ)

False

expirydate

string(date-time)

(Show until)

Set how long after a card is generated it should expire. Default is 24 hours - utcNow().addHours(24). (UTC format: yyyy-MM-ddTHH:mm:ssZ)

False

 

Returns:

          Type:CreateActionCard_V3Response

 

GetCrmOrganizationList

Summary: Get CRM organization list

Description: Get list of CRM organizations.

 

Syntax:

Dynamics365SalesInsights.GetCrmOrganizationList ()

 

Returns:

          Type:OrganizationsList

          Description: List of organization.

 

GetEligibleRegardingEntities

Summary: Get entity list

Description: Get list of entities.

 

Syntax:

Dynamics365SalesInsights.GetEligibleRegardingEntities (string organization)

 

Parameters:

Name

Type

Summary

Required

Related Action

organization

string

(Organization Name)

Name of Dynamics 365 organization like Contoso.

True

GetCrmOrganizationList

 

Returns:

          Type:EntityList

          Description: Represents a list of CRM Entities.

 

GetCrmEntityList

Summary: Get entity list

Description: Get list of entities.

 

Syntax:

Dynamics365SalesInsights.GetCrmEntityList (string organization)

 

Parameters:

Name

Type

Summary

Required

Related Action

organization

string

(Organization Name)

Name of Dynamics 365 organization like Contoso.

True

GetCrmOrganizationList

 

Returns:

          Type:EntityList

          Description: Represents a list of CRM Entities.

 

CreateCustomActionDefinition

Summary: Choose custom action (CRM process) for insight card

Description: The output of this step should be used in the "Create card for assistant V2" step, when Button type is Custom action (CRM process)

 

Syntax:

Dynamics365SalesInsights.CreateCustomActionDefinition (string organization, string entityname, string customaction, CreateCustomActionDefinitionParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

organization

string

(Environment (org))

Choose the Dynamics 365 environment (org) in which you want to create the insight card.

True

GetCrmOrganizationList

entityname

string

(Filter by entity)

Choose the primary entity that the custom action is associated with (custom values are not supported)

True

GetEntityListForCustomAction

customaction

string

(Custom action (CRM process))

Choose the custom action to use (custom values are not supported)

True

GetCustomActionList

body

CreateCustomActionDefinitionParameterBody

 

 

True

 

Returns:

          Type:stringCustom action for insight card

Title: Custom action for insight card

          Description: Represents a custom action for insight card.

 

GetActionTypes

Summary: Get action types list

Description: Get action types list.

 

Syntax:

Dynamics365SalesInsights.GetActionTypes ()

 

Returns:

          Type:ActionTypesList

          Description: Represents a list of action types.

 

GetActionTypesV2

Summary: Get action types v2 list

Description: Get action types v2 list.

 

Syntax:

Dynamics365SalesInsights.GetActionTypesV2 ()

 

Returns:

          Type:ActionTypesList

          Description: Represents a list of action types.

 

GetPostOperations

Summary: Get post operations list

Description: Get post operations list.

 

Syntax:

Dynamics365SalesInsights.GetPostOperations ()

 

Returns:

          Type:PostOperationsList

          Description: Represents a list of post operations.

 

GetEntityListForCustomAction

Summary: Get entity list for custom action

Description: Get list of entities for custom action.

 

Syntax:

Dynamics365SalesInsights.GetEntityListForCustomAction (string organization)

 

Parameters:

Name

Type

Summary

Required

Related Action

organization

string

(Organization Name)

CRM organization to be connected. Eg Contoso.

True

GetCrmOrganizationList

 

Returns:

          Type:EntityList

          Description: Represents a list of CRM Entities.

 

GetDynamicFieldsForActionType

Summary: Get dynamic fields for action type

Description: Get dynamic fields for action type.

 

Syntax:

Dynamics365SalesInsights.GetDynamicFieldsForActionType (string organization, string actiontype, [Optional]string secondaryactiontype, [Optional]string version)

 

Parameters:

Name

Type

Summary

Required

Related Action

organization

string

(Organization Name)

CRM organization to be connected. Eg Contoso.

True

GetCrmOrganizationList

actiontype

string

(Action type)

Action type

True

secondaryactiontype

string

(Secondary action type)

Secondary action type

False

version

string

(Api version number)

Api version number

False

 

Returns:

          Type:Object

 

GetCustomActionParameters

Summary: Get parameters for custom action

Description: Get parameters for custom action.

 

Syntax:

Dynamics365SalesInsights.GetCustomActionParameters (string organization, string customaction)

 

Parameters:

Name

Type

Summary

Required

Related Action

organization

string

(Organization Name)

CRM organization to be connected. Eg Contoso.

True

GetCrmOrganizationList

customaction

string

(Custom Action)

Custom Action

True

 

Returns:

          Type:Object

 

GetCustomActionList

Summary: Get custom actions list

Description: Get custom actions list.

 

Syntax:

Dynamics365SalesInsights.GetCustomActionList (string organization, string entityname)

 

Parameters:

Name

Type

Summary

Required

Related Action

organization

string

(Organization Name)

CRM organization to be connected. Eg Contoso.

True

entityname

string

(Entity)

Entity.

True

 

Returns:

          Type:CustomActionList

          Description: Represents a list of custom actions.

 

GetPlaybookTemplates

Summary: Get playbook templates list

Description: Get playbook templates list.

 

Syntax:

Dynamics365SalesInsights.GetPlaybookTemplates (string organization)

 

Parameters:

Name

Type

Summary

Required

Related Action

organization

string

(Organization Name)

CRM organization to be connected. Eg Contoso.

True

GetCrmOrganizationList

 

Returns:

          Type:PlaybookTemplatesList

          Description: Represents a list of playbook templates.

 


 

ActionTypes

Summary:

Description: Represents an action type.

 

          Properties:

Name

Type

Summary

Name

string

 

The name of the action type.

DisplayName

string

 

The display name of the action type.


 

ActionTypesList

Summary:

Description: Represents a list of action types.

 

          Properties:

Name

Type

Summary

value

array of (ActionTypes)

 

List of action types.


 

BodyFieldsForCreateActionCardV3

Summary:

Description: Describes the fields for CreateActionCard_V3

 

          Properties:

Name

Type

Summary

cardname

string

 

Simple text only (no dynamic content or expressions). Card name is shown in the insight card list and at the top of the card.

title

string

 

Enter a title to appear in the card header.

description

string

 

Enter text for the body of the insight card.

dynamicproperties

Dynamicproperties

 

 

 

Dynamicproperties

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

CreateActionCardParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

cardname

string

 

Simple text only (no dynamic content or expressions). Card name is shown in the insight card list and at the top of the card.

title

string

 

Enter a title to appear in the card header.

description

string

 

Enter text for the body of the insight card.

action

string

 

Choose a button type.  Values: [Open URL, Open Entity]

actionparam

string

 

Enter the URL or record ID that the button should open.

regardingobjectid

string

 

Enter the dynamic value with the record ID for the display entity.

ownerid

string

 

Enter a dynamic value to define who should see this card (usually "Owner").

startdate

string

 

Set how long after a card is generated it should be shown. Default is immediate - utcNow().

expirydate

string

 

Set how long after a card is generated it should expire. Default is 24 hours - utcNow().addHours(24).


 

CreateActionCardResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

CreateActionCard_V2ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

CreateActionCard_V2Response

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

CreateActionCard_V3Response

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

CreateCustomActionDefinitionParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

CustomAction

Summary:

Description: Represents a custom action.

 

          Properties:

Name

Type

Summary

Name

string

 

The name of the custom action.

DisplayName

string

 

The display name of the custom action.


 

CustomActionList

Summary:

Description: Represents a list of custom actions.

 

          Properties:

Name

Type

Summary

value

array of (CustomAction)

 

List of custom actions.


 

Entity

Summary:

Description: Represents a CRM Entity.

 

          Properties:

Name

Type

Summary

Name

string

 

The name of the Entity. The name is used at runtime.

DisplayName

string

 

The display name of the Entity.


 

EntityList

Summary:

Description: Represents a list of CRM Entities.

 

          Properties:

Name

Type

Summary

value

array of (Entity)

 

List of Entities.


 

Object

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Organization

Summary:

Description: Organization.

 

          Properties:

Name

Type

Summary

Name

string

 

Organization name.

DisplayName

string

 

Organization display name.


 

OrganizationsList

Summary:

Description: List of organization.

 

          Properties:

Name

Type

Summary

value

array of (Organization)

 

List of organizations.


 

PlaybookTemplate

Summary:

Description: Represents a playbook pemplate.

 

          Properties:

Name

Type

Summary

Name

string

 

The name of the playbook template.

DisplayName

string

 

The display name of the playbook template.


 

PlaybookTemplatesList

Summary:

Description: Represents a list of playbook templates.

 

          Properties:

Name

Type

Summary

value

array of (PlaybookTemplate)

 

List of playbook templates.


 

PostOperation

Summary:

Description: Represents a post operation.

 

          Properties:

Name

Type

Summary

Name

string

 

The name of the post operation.

DisplayName

string

 

The display name of the post operation.


 

PostOperationsList

Summary:

Description: Represents a list of post operations.

 

          Properties:

Name

Type

Summary

value

array of (PostOperation)

 

List of post operations.