Pabbly Connect Integration Best Practices

Status
Not open for further replies.
Action/Trigger Name:
Simple and Short (The first letter of each word must be capital)​
Example: Update Contact

Action/Trigger Description:
In a few words describe the functionality of the action/trigger. Write the description in the third person and capitalize only the first letter of the first word in the description (like a normal sentence structure).​
Example: Description for the action Update Contact.​
Updates the contact details for a specified contact.​

Instructions for adding help text for connection fields:

For Parameters/Headers based authentication applications
1. Write proper sentences and standards like API Key not API key or API key or as mentioned in the application’s API documentation/Dashboard.​
3. Use links wherever possible in the new window​
4. For a single parameter, you can write the Help Texts at the app level instead of writing to each endpoint level as shown below:​
nCRrzJm4twTpVxmKWnfL2UXYnhUCcUb_qSAcCbCOq0oBSUx005dy-qBY5qJstJOGPWRNz7ekUzDHN7rxmAH1BsnsYPGLB8VEVJesiFzDvClzh9SNOGgb_artb5E_e_R72MMjHDSi=s1600
5. Instructions must be precise and simple and if possible add navigation links to the API area of the app.​
For Basic Auth based authentication applications
1. Make use of a placeholder and write the exact parameter to be input ex: API Key (K not k), Secret Key (K not k), you can check any previous app for reference.​
2. In the description, write: Enter your API Key and Secret Key then, press single enter and write the instructions from where it can be found in the application.​
3. In some cases only the first field of Basic Auth is required and the next one needs to be left blank. In such cases, Add a placeholder for the first field and leave the second one as it is the, you can write the first line of description as Enter your API Key and leave Password field blank​
3. Use links wherever possible​
4. Instructions must be clear and simple, check the below screenshot:
Mjywn7sIJSaTJdndxxCSQjB8bXXEE-KXtyPlOGsFX679PiHLMOkX5yitTenROF9C-M4ONFHwwwpt7LzGuRepBOubc8fX1nWq8eBx9brjwZv2s_xsUXqz09mP1EUGG0RmCKFt8Np9=s1600
Instructions for adding help text for action/trigger fields:

While configuring the Action/Trigger Event API Configuration section, all the parameters/variables must have a proper help text with example in it as shown in the below screenshots:​
an20Gyi3PO8n-aq4sYpUe8Lt4xoPlODdgJkDvhhG48rPB2fVbqeTVQk0zad-1mA84BASewbk1NJCTrsEfrYr08116q3dkPYQj8MnVY7dvay9jaXKU1YJO-GqPlkNzZNjaL8zQIUa=s1600
JxDcYP4RrC1F8xoN37J3AK3YTZa6GqSBW4vh3smQ8evQnPexaiGUYH5DeBkpPAXBG2-FJYNPKa3nEssnUZ8esJHYav8bh3d0Lz7iWln7fV1g11fYr1URt7BAs-BBoKCiLgTce6_7=s1600
 
Last edited:
Status
Not open for further replies.
Top