ByteChef LogoByteChef

Microsoft Dynamics CRM

Microsoft Dynamics CRM is a customer relationship management software that helps businesses manage customer interactions, sales, marketing, and customer service processes efficiently.

Categories: CRM

Type: microsoftDynamicsCrm/v1


Connections

Version: 1

OAuth2 Authorization Code

Properties

NameLabelTypeDescriptionRequired
clientIdClient IdSTRINGtrue
clientSecretClient SecretSTRINGtrue
tenantIdTenant IdSTRINGtrue
hostUrlHost URLSTRINGHost URL without trailing slash. For example https://demo.crm.dynamics.comtrue
proxyUrlProxy URL with PortSTRINGOnly to use for establishing connections (only needed when proxying requests). For example https://proxy.com:8080.false

Connection Setup

Create OAuth 2.0 Application

Creation of OAuth 2.0 application is documented here.

Grant Necessary Permissions

  1. Open the Azure Portal: https://portal.azure.com/
  2. Click on App registrations.
  3. Click on All applications.
  4. Click on the application you want to connect to Microsoft Dynamics CRM.
  5. Click on API permissions.
  6. Select Dynamics CRM.
  7. Select Delegated permissions.
  8. Select the following scopes:
    • user_impersonation
  9. After selecting all the scopes, click on Update permissions

Actions

Create Record

Name: createRecord

Creates a new record.

Properties

NameLabelTypeDescriptionRequired
entityTypeEntity TypeSTRINGSelect or map the entity for which you want to create the record.true
fieldsDYNAMIC_PROPERTIES
Depends On entityType
true

Example JSON Structure

{
  "label" : "Create Record",
  "name" : "createRecord",
  "parameters" : {
    "entityType" : "",
    "fields" : { }
  },
  "type" : "microsoftDynamicsCrm/v1/createRecord"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Delete Record

Name: deleteRecord

Creates a new record.

Properties

NameLabelTypeDescriptionRequired
entityTypeEntity TypeSTRINGSelect or map the entity name whose records you want to delete.true
recordIdRecord IDSTRING
Depends On entityType
true

Example JSON Structure

{
  "label" : "Delete Record",
  "name" : "deleteRecord",
  "parameters" : {
    "entityType" : "",
    "recordId" : ""
  },
  "type" : "microsoftDynamicsCrm/v1/deleteRecord"
}

Output

This action does not produce any output.

Get Record

Name: getRecord

Retrieves an existing record.

Properties

NameLabelTypeDescriptionRequired
entityTypeEntity TypeSTRINGSelect or map the entity name whose records you want to retrieve.true
recordIdRecord IDSTRING
Depends On entityType
true

Example JSON Structure

{
  "label" : "Get Record",
  "name" : "getRecord",
  "parameters" : {
    "entityType" : "",
    "recordId" : ""
  },
  "type" : "microsoftDynamicsCrm/v1/getRecord"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

List Records

Name: listRecords

Retrieves all records of a given entity type.

Properties

NameLabelTypeDescriptionRequired
entityTypeEntity TypeSTRINGSelect or map the entity name whose records you want to retrieve.true

Example JSON Structure

{
  "label" : "List Records",
  "name" : "listRecords",
  "parameters" : {
    "entityType" : ""
  },
  "type" : "microsoftDynamicsCrm/v1/listRecords"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Update Record

Name: updateRecord

Updates an existing record.

Properties

NameLabelTypeDescriptionRequired
entityTypeEntity TypeSTRINGSelect or map the entity for which you want to update the record.true
recordIdRecord IDSTRING
Depends On entityType
true
fieldsDYNAMIC_PROPERTIES
Depends On entityType
true

Example JSON Structure

{
  "label" : "Update Record",
  "name" : "updateRecord",
  "parameters" : {
    "entityType" : "",
    "recordId" : "",
    "fields" : { }
  },
  "type" : "microsoftDynamicsCrm/v1/updateRecord"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Triggers

New Account

Name: newAccount

Triggers when new account is created.

Type: POLLING

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

JSON Example

{
  "label" : "New Account",
  "name" : "newAccount",
  "type" : "microsoftDynamicsCrm/v1/newAccount"
}

Updated Account

Name: updatedAccount

Triggers when an account is updated.

Type: POLLING

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

JSON Example

{
  "label" : "Updated Account",
  "name" : "updatedAccount",
  "type" : "microsoftDynamicsCrm/v1/updatedAccount"
}

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

How is this guide?

Last updated on

On this page