​
What’s supported

​
Supported actions

This connector supports:
  • Read Actions, including full historic backfill. Please note that incremental read is not supported, a full read of the Dixa instance will be done for each scheduled read.
  • Write Actions.
  • Proxy Actions, using the base URL https://dev.dixa.io.

​
Supported Objects

The Dixa connector supports reading from the following objects: The Dixa connector supports writing to the following objects:

​
Example integration

For an example manifest file of an Dixa integration, visit our samples repo on Github.

​
Before You Get Started

​
Creating an API key for Dixa

Click here for more information about generating an API key for Dixa. The UI components will display this link, so that your users can successfully create API keys.

​
Using the connector

This connector uses API Key auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.) To start integrating with Dixa:
  • Create a manifest file like the example.
  • Deploy it using the amp CLI.
  • If you are using Read Actions, create a destination.
  • Embed the InstallIntegration UI component. The UI component will prompt the customer for an API key.
  • Start using the connector!
    • If your integration has Read Actions, you’ll start getting webhook messages.
    • If your integration has Write Actions, you can start making API calls to our Write API.
    • If your integration has Proxy Actions, you can start making Proxy API calls.