• Instructions to Ask a Question

    Click on the "Ask a Question" button and select the application for which you would like to ask questions.

    We have 5 different products namely - Pabbly Connect, Pabbly Subscription Billing, Pabbly Email Marketing, Pabbly Form Builder, Pabbly Email Verification.

    The turnaround time is 24 hrs (Business Hours - 10.00 AM to 6.00 PM IST, Except Sunday). So your kind patience will be highly appreciated!

  • Important: Any reported problems and issues with your integration will be reported to you and we will encourage the app developers help to resolve those integration issues.

Configure Inbuilt Actions

Status
Not open for further replies.
Here you can create an inbuilt action event(s) with basic details like Name, Description, Video Tutorial (if any) and API endpoint along with parameters.

Use a Simple Response type if the inbuilt action event will give data that is ready to map, else Advance Response will give you packaged data.

Inbuilt Action Name:
Simple and Short (The first letter of each word must be capital)​
Example: List Subscribers

Inbuilt Action Description:
In a few words describe the functionality of the inbuilt action. 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: Lists all the subscribers.
Inbuilt Action Types:

Pabbly Connect supports 3 types of inbuilt action event integration viz, Dropdown & Custom Fields (Default), App Auth Validator and Multi-Step are as follows:

  1. Dropdown & Custom Fields (Default) - This type of inbuilt action is used to create a dropdown field to map in action or trigger events.
Inbuilt Actions Event API Configuration:
  • HTTP request method -Specify an HTTP method to request this inbuilt action event e.g. GET
  • API Endpoint URL - The URL to communicate with third-party applications using the HTTP request method to either push or receive data from them e.g. https://emails.pabbly.com/api/subscribers-list
  • Request Body Type - Specify a request body type to request this inbuilt 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 Body/Query Parameters if this trigger event requires passing the query/URL parameters or map in request raw JSON e.g. list_name.
  • Request Body (Raw JSON) - Select this if this trigger event requires passing the raw JSON data. If used in endpoints then, all variables in it defined under the Set Body/Query Parameters option should have the required option opted. (Some API accepts blank values for JSON keys)
Here is an example -​
1635771468904.png
2. App Auth Validator - Validates whether app authentication is correct or not. To integrate this inbuilt action API Endpoint URL should return Unauthorized header status and 401 status code.​
Inbuilt Actions Event API Configuration:
  • HTTP request method - Specify an HTTP method to request this inbuilt action event e.g. GET
  • API Endpoint URL - The URL to communicate with third-party applications using the HTTP request method to either push or receive data from them e.g. https://emails.pabbly.com/api/subscribers-list
  • Request Body Type - Specify a request body type to request this inbuilt 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 Body/Query Parameters if this trigger event requires passing the query/URL parameters or map in request raw JSON e.g. list_name.
  • Request Body (Raw JSON) - Select this if this trigger event requires passing the raw JSON data. If used in endpoints then, all variables in it defined under the Set Body/Query Parameters option should have the required option opted. (Some API accepts blank values for JSON keys)
Here is an example -​
1635771655267.png
3. Multi-Step - inbuilt action that is used to execute after-action or trigger events.​
Inbuilt Actions Event API Configuration:
  • HTTP request method - Specify an HTTP method to request this inbuilt action event e.g. GET
  • API Endpoint URL- The URL to communicate with third-party applications using the HTTP request method to either push or receive data from them e.g. https://emails.pabbly.com/api/subscribers-list
  • Request Body Type - Specify a request body type to request this inbuilt 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 Body/Query Parameters if this trigger event requires passing the query/URL parameters or map in request raw JSON e.g. list_name.
  • Request Body (Raw JSON) - Select this if this trigger event requires passing the raw JSON data. If used in endpoints then, all variables in it defined under the Set Body/Query Parameters option should have the required option opted. (Some API accepts blank values for JSON keys)
Here is an example -​
1635771780850.png
  • Transform Object To Array (optional) - Select if your API response JSON needs to transform from object to array.

Case 1- Add inbuilt action events if required to map dropdown field values in this inbuilt action event, you need to make use of the Inbuilt Action step just above the Inbuilt Action Event API Configuration section by clicking the plus (+) button.​
Now, select the available inbuilt action events from the dropdown field as shown below:​
1634815638383.png
Then, you can define the parameter key in the Set Body/Query Parameters option.​
1635771993169.png
and you can configure that parameter key and value for the requested raw JSON as shown below:​
1635772101746.png


If you want to map the response of any action, trigger or inbuilt action step in the multi-step parameter then, you can use the static parameter value option as shown below:

1636115021030.png


Request Body (Raw JSON) will lokk like:​
1634815988811.png
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)​
 

Attachments

  • 1634815482093.png
    1634815482093.png
    28.2 KB · Views: 46
  • 1634815511716.png
    1634815511716.png
    32.4 KB · Views: 48
  • 1634815539348.png
    1634815539348.png
    44.1 KB · Views: 41
  • 1634815592414.png
    1634815592414.png
    22.8 KB · Views: 33
  • 1634815919868.png
    1634815919868.png
    37.5 KB · Views: 32
  • 1634815958964.png
    1634815958964.png
    37.4 KB · Views: 38
  • 1634815973112.png
    1634815973112.png
    15 KB · Views: 42
Last edited:
Status
Not open for further replies.
Top