This article will show you how to create a Simple Integration.
Note that all dropdowns throughout this workflow are auto-complete drop-downs so you can narrow down your options by typing into the field.
- Navigate to the Integrations tab
- Click + New Integration
- Select the Simple integration card
Step 1: Design
Fill out the following fields on the Design screen:
- Short Description: Add a brief description for your integration that will be used as a title.
- Select a Trigger or Action from the drop-down
Note: In most situations after selecting your Trigger and Action, a field for Credentials will be displayed. Only the applicable credentials for your selected Trigger or Action will be displayed (i.e. only HCMS credentials will be displayed if you choose HCMS as your Trigger, or only CivicReady credentials will be displayed if you choose CivicReady as your Action. Additional fields will be displayed after you select a credential. Learn more about Actions and Triggers.
When you are finished completing all required fields for both your Trigger and Action, you can select Next to be brought to the Configure step for your integration.
Step 2: Configure
Configure the fields for your action. On this screen, you will be presented with two columns. The fields from your Trigger will be on the left in chips and the fields from your Action will be in the column on the right. The fields for both your Trigger and your Action will depend on what you chose in Step 1.
There are two types of action fields that may show up in the column on the right.
Once all required fields are filled out, users can select Next to move on to Step 3. At any point, you may select Back or click on Design in the progress bar at the top to be brought back to the previous step. Note that if any changes are made, the fields in step 2 will likely change and your previous selections may be lost.
Step 3: Test & Confirm
The third and final step for your Simple Integration setup is the Test & Confirm step. On this screen, you will see an overview of your integration where you can preview what will trigger and be completed with this integration.
On this screen, you will also see step-by-step instructions on how to test your integration. Note that you will need to first save and enable your integration before your integration can be triggered as described in the Test Instructions.
To save your integration, all you need to do now is select the Save button. If after reviewing your integration overview you need to make changes to the integration, you can return to Step 2 by clicking the Back button.