Use the Business Central Dataverse API

Use the Dataverse API for Business Central to notify Business Central when a row changes in Dataverse. Use this API only when Dataverse synchronization is enabled.

The API is commonly called from a Power Automate flow that uses the When a row is added, modified, or deleted trigger.

Business Central Dataverse API endpoint

The Dataverse API is a custom API with the following route:

https://api.businesscentral.dynamics.com/v2.0/{environmentName}/api/microsoft/dataverse/v1.0

Company-specific entity change requests use the following resource:

companies({companyId})/dataverseEntityChanges

Learn more about Business Central API URLs in API endpoint structure.

Notify Business Central about a Dataverse change

Set entityName to the logical name of the Dataverse table that changed. When you create an entity change, Business Central reschedules the applicable Dataverse synchronization job queue entry to run immediately.

The following example notifies Business Central that a row in the Dataverse account table changed.

Request

POST https://api.businesscentral.dynamics.com/v2.0/production/api/microsoft/dataverse/v1.0/companies(00aa00aa-bb11-cc22-dd33-44ee44ee44ee)/dataverseEntityChanges
Authorization: Bearer {token}
Content-Type: application/json

{
  "entityName": "account"
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
  "entityName": "account"
}

Get Dataverse entity changes

Use a GET request to retrieve entity changes for a company. The response can contain many entries.

Request

GET https://api.businesscentral.dynamics.com/v2.0/production/api/microsoft/dataverse/v1.0/companies(00aa00aa-bb11-cc22-dd33-44ee44ee44ee)/dataverseEntityChanges
Authorization: Bearer {token}

Response

{
  "value": [
    {
      "id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "entityName": "account"
    }
  ]
}

Related information

Company resource type
Dataverse entity change resource type
Subscription resource type
Integrate Business Central with Microsoft Dataverse
When a row is added, modified, or deleted trigger