Login to your Pabbly Connect account: https://accounts.pabbly.com/login.
In case, you don't have a Pabbly Connect account then, you can create one from here: https://accounts.pabbly.com/signup/
Once you have logged in to your Pabbly Connect account then, you can start building your app integration through this link: https://connect.pabbly.com/app
First, you need to Create an App along with the authentication methods as explained in this article: https://forum.pabbly.com/threads/app-details-and-auth-configuration.2426/
Once, you have configured the app details then, visit the Actions section by clicking the Actions on the left panel menu and you can create an action event(s) with basic details like Name, Description, Video Tutorial (if any) and API endpoint along with parameters.
Action Name:
Action Description:
Action Event API Configuration with JSON Request Body Type -
Action Event API Configuration with Form-Data Request Body Type -
If your app’s API requires content-type:application/x-www-form-urlencoded and you need to pass data query parameters. This request body type allows you to add more fields from workflow by clicking on plus button.
There are some cases for the Actions configuration which depends on the app's requirements as explained below:
In case, you don't have a Pabbly Connect account then, you can create one from here: https://accounts.pabbly.com/signup/
Once you have logged in to your Pabbly Connect account then, you can start building your app integration through this link: https://connect.pabbly.com/app
First, you need to Create an App along with the authentication methods as explained in this article: https://forum.pabbly.com/threads/app-details-and-auth-configuration.2426/
Once, you have configured the app details then, visit the Actions section by clicking the Actions on the left panel menu and you can create an action event(s) with basic details like Name, Description, Video Tutorial (if any) and API endpoint along with parameters.
Action Name:
Simple and Short (The first letter of each word must be capital)
Example: Update Contact
Action Description:
In a few words describe the functionality of the action/trigger. Write the description in 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 .
Action Event API Configuration with JSON Request Body Type -
- HTTP request method - Specify an HTTP method to request this action event e.g. POST
- API Endpoint URL - The URL to communicate with third-party applications using the HTTP request method in order to either push or receive data from them e.g. https://emails.pabbly.com/api/subscribers-list/create
- Request Body Type - Specify a request body type to request this action event. By default, it is JSON.
- Wrap in Array - Specify if your request raw JSON needs to be wrapped in an array or not.
- HTTP Headers - API headers serve as an additional source of data for each API call you make. It is used to represent the meta-data that goes along with an API request.
- Set Body/Query Parameters - Set parameters if this action event requires to pass the query/URL parameters or map in request raw JSON e.g. list_name.
- Request Body (Raw JSON) - Select this if this action event requires to pass the raw JSON data. If used in endpoints then, all variables in it defined under Set parameters option should have required option opted. (Some API accepts blank values for JSON keys).
Action Event API Configuration with Form-Data Request Body Type -
If your app’s API requires content-type:application/x-www-form-urlencoded and you need to pass data query parameters. This request body type allows you to add more fields from workflow by clicking on plus button.
- HTTP request method - Specify an HTTP method to request this action event e.g. POST
- API Endpoint URL - The URL to communicate with third-party applications using the HTTP request method in order to either push or receive data from them e.g. https://emails.pabbly.com/api/subscribers-list/create
- Request Body Type - Specify a request body type as Form-data to request this action event.
- HTTP Headers - API headers serve as an additional source of data for each API call you make. It is used to represent the meta-data that goes along with an API request.
- Set Body/Query Parameters - Set parameters if this action event requires passing the query/URL parameters. e.g. list_name.
Action Event API Configuration with XML Request Body Type -- HTTP request method - Specify an HTTP method to request this action event e.g. POST
- API Endpoint URL - The URL to communicate with third-party applications using the HTTP request method in order to either push or receive data from them e.g. https://emails.pabbly.com/api/subscribers-list/create
- Request Body Type - Specify a requested body type as XML to request this action event.
- HTTP Headers - API headers serve as an additional source of data for each API call you make. It is used to represent the meta-data that goes along with an API request.
- Set Body/Query Parameters - Set parameters if this action event requires passing the query/URL parameters. e.g. list_name.
Note: you can use parameters within double curly braces e.g. https://{{subdomain}}.example.com/api/v3/contacts?api-key={{api-key}} in the API Endpoint URL (if required)
Refer to the below video for creating an action of your app:
There are some cases for the Actions configuration which depends on the app's requirements as explained below:
Case 1 - If it is required to generate dropdown field values in the action event, you need to make use of the Inbuilt Action step just above the Action Event API Configuration section by clicking the plus (+) button.
Now, select the available inbuilt action events from the dropdown field as shown below:
Then, you can define the parameter key in the Dynamic Dropdown (Optional) option and you can configure that parameter key and value for the requested raw JSON as shown below:
Case 2. Making an action compatible with Line Items (Optional).
Find the JSON object key of the request body to dynamically build line item(s) objects e.g. items. You can read more about this from here: https://forum.pabbly.com/threads/ho...with-line-item-s-like-body-request-json.2566/
Then define the JSON object key of the request body to dynamically build line item(s) objects.
Read more configuring actions compatible with Line Item(s) like Body Request JSON from here.
Case 3. Configuring Request Body JSON of an Action with Dynamic/Custom Fields
Custom fields of an application are the dynamic fields configured by the app users in their app dashboard. Many applications like MailChimp, Mailerlite, Pabbly Email Marketing etc. allows user to manage their contacts, lists, subscribers etc based on custom fields.
You can read more about configuring the action with custom fields from here: https://forum.pabbly.com/threads/ho...of-an-action-with-dynamic-custom-fields.2577/
Case 4. Multi-step Action (if required to execute an inbuilt multi-step action after the action response.) you need to make use of the inbuilt multi-step action after the Action Event API Configuration section by clicking the plus (+Multi-step Action) button.
Now, select the available inbuilt action events from the dropdown field as shown below:
Attachments
Last edited by a moderator:
