Skip to main content

Microsoft Dataverse

Sync overview

This source can sync data for the Microsoft Dataverse API to work with Microsoft Dataverse.

This connector currently uses version v9.2 of the API

Output schema

This source will automatically discover the schema of the Entities of your Dataverse instance using the API https://<url>/api/data/v9.2/EntityDefinitions?$expand=Attributes

Data type mapping

Integration TypeAirbyte TypeNotes
Stringstring
UniqueIdentifierstring
DateTimetimestamp with timezone
Integerinteger
BigIntinteger
Moneynumber
Booleanboolean
Doublenumber
Decimalnumber
Statusinteger
Stateinteger
VirtualNoneWe skip virtual types

Other types are defined as string.

Features

FeatureSupported?(Yes/No)Notes
Full Refresh SyncYes
Incremental SyncYes
CDCYesNot all entities support it. Deleted data only have the ID
Replicate Incremental DeletesYes
SSL connectionYes
NamespacesNo

Getting started

Requirements

  • Application (client) ID
  • Directory (tenant) ID
  • Client secrets

Setup guide

The Microsoft Dataverse API uses OAuth2 for authentication. We need a 'client_credentials' type, that we usually get by using an App Registration. https://learn.microsoft.com/en-us/power-apps/developer/data-platform/authenticate-oauth

The procedure to generate the credentials and setup the necessary permissions is well described in this post from Magnetism blog: https://blog.magnetismsolutions.com/blog/paulnieuwelaar/2021/9/21/setting-up-an-application-user-in-dynamics-365

Reference

Config fields reference

Field
Type
Property name
string
url
string
tenant_id
string
client_id
string
client_secret_value
integer
odata_maxpagesize

CHANGELOG

VersionDatePull RequestSubject
0.1.22023-08-2429732🐛 Source Microsoft Dataverse: Adjust source_default_cursor when modifiedon not exists
0.1.12023-03-1622805Fixed deduped cursor field value update
0.1.02022-11-1418646🎉 New Source: Microsoft Dataverse [python cdk]