Overview

To start defining integrations with Ampersand, create a new directory (we recommend calling it integrations), which will hold your amp.yaml file. All your integrations should be defined in the same amp.yaml file.

integrations/
  amp.yaml

The top-level keys of amp.yaml are the following:

• specVersion: the version of the amp.yaml spec used, the current version is 1.0.0
• integrations: the list of integrations that your users can install

The top-level keys of an integration are:

• name: the name of the integration, only alphanumeric characters and dashes are allowed.
• provider: the API that this integration connects to.
• each integration can include:
  • Read Actions
  • Write Actions

Putting all of this together, the basic structure of an amp.yaml file looks like the following:

specVersion: 1.0.0

integrations: 
- name: readSalesforceAccounts
  provider: salesforce
  read:
   ...
  write:
   ...