Register account and get API key

Register account

First of all, you need to register Plumsail Account. This account is used to manage Plumsail Actions and Plumsail Forms products.

It is better to use your active email address. The subscription will be linked to this address.

If you already have an account, just sign in to

Generate API key

You need to navigate to the "API Keys" section and click "Add new". Then select type of API key according to your needs.

API keys

API Key for Documents actions

If you want to use Plumsail Documents connector in Microsoft Flow or Documents processing REST API, you need to select "Documents" type of API key and click "Submit". You can also specify the name of the key:

API keys

API Key for SharePoint actions

If you want to use Plumsail SharePoint connector in Microsoft Flow or SharePoint processing REST API, you have two options:

  • SharePoint - App auth
  • SharePoint - Custom credentials

SharePoint - App auth authenticates Actions as an app in your SharePoint tennant. You need to fill domain of your SharePoint Online, click "Submit" and then click "Accept" in the opened window. You may need to allow your browser to open popup windows.

API keys

SharePoint - Custom credentials allows SharePoint actions to work under account of specific user. You need to fill account name and password for your user:

API keys

Copy and use API key

Once you created an API key, you can see your key right in the "Secret" column. You can also change a name of a key by clicking on it in the "Name" column:

API keys

Now you can copy and use it in: