After selecting the Simple Integration card, you will be taken through steps for designing, configuring, and testing & confirming your 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.
Step 1: Design
On this screen, you can add a brief description for your integration that will be used as a title. You can then select your Trigger and Action.
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.
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
After selecting Next on Step 1, you will be brought to Step 2 of setting up your simple integration where you can 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.
- Autocomplete Dropdowns
- Custom Text Input Fields
Once all required fields are filled out, users can select Next to move on Step 3. At any point, users can 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. See our articles on Autocomplete Dropdown Fields and Custom Text Input Fields for more information.
Step 3: Test & Confirm
The third and final step for your simple integration setup is the Text & Confirm step. We are currently working on enhancing this step, so there’s not much to do on this page right now.
On this screen, you just need to select the “Save” button to save your integration. If needed, you can return to previous steps by clicking the back button to return to Step 2.