Microsoft Dynamics CRM Integration Guide

Microsoft Dynamics CRM Integration

Microsoft Dynamics CRM showing a case created from a DChat conversation

This guide documents the older Web Forms CRM bridge using ChatApi.asmx. It does not apply directly to the current .NET 8 package. The bridge package is not available for download here; contact us if you maintain an older deployment and need the integration files.

Ask about the legacy integration

0. Before You Begin

Please install the main DChat deployment and the API demo site first.

1. Copy Integration package to your application directory

Unzip ApiCrmWeb.zip to a new folder where you want the site to be hosted from (eg C:\websites\ApiCrmWeb).

The unzipped integration package copied into a new website folder

2. Configure the Web Site in IIS

Open up IIS Manager, select the Default Web Site (under Sites) and click the Stop button. Now, right click on Sites and select Add Website...

Provide a site name and the folder you want the site to be hosted from.

Creating the integration website in IIS Manager

3. Modify DChat Web site web.config to register ChatApiNotificationUrl and ChatApiKey

ChatApiKey creates a trusted connection between the main DChat deployment (chat.example.com) and the CRM bridge site (crm-bridge.example.com).

Please open the main DChat site's web.config and register the notification URL used by the CRM bridge listener, for example https://crm-bridge.example.com/handle_chatapi_notification.ashx.

The DChat web.config with ChatApiNotificationUrl registered

4. Modify CRM Web web.config to register ChatApiServiceUrl and ChatApiKey

ChatApiKey in the CRM bridge web.config must match the ChatApiKey configured in the main DChat deployment.

Please open the CRM bridge web.config and register the service URL exposed by your DChat deployment, for example https://chat.example.com/ChatApi.asmx.

The CRM web.config with ChatApiServiceUrl and ChatApiKey registered

5. You are all set!

If you installed CRM Web correctly, you will see the following screen that lets you know you're good to go.

The completed configuration, ready to test

6. Start a chat conversation and test interaction between CRM data and chat records

A chat conversation started from the visitor widget

Click "Welcome, click more information about this visitor: Tester". A new window will be opened.

The agent answering the conversation in the DChat console

view_contact.aspx is an example showing how to access Contact Object. Click and you will enter CRM page.

The conversation arriving in Dynamics CRM as a new case

The completed case in Dynamics CRM with the chat transcript attached

Self-hosted customer support software

Deploy live chat on your own terms, not on someone else's pricing model.

DChat gives you the installable server, web dashboard, website widget, and desktop agent tools in one self-hosted product, with live chat free to run, and an AI agent that answers, acts with the approvals you set and hands off to your team when you want one. Run it on infrastructure you trust, on the model you choose.

Deployment

Install on Windows or Linux, behind IIS or Nginx, in a VM, or in Docker if that fits your stack.

Commercial model

Live chat is free with unlimited agents. Premium, with the AI agent, is billed per agent per month, never per conversation.

AI Flexibility

Run the AI agent on a local Ollama model, or connect OpenAI and Anthropic with your own provider accounts.