viaSocket’s Plugin builder empowers both app developers and everyday users to create custom integrations, bringing new apps into the platform with ease. Whether you're an app company looking to extend your app's reach or a user wanting to automate tasks across your favorite tools, viaSocket offers the flexibility you need. 

​

For Developers: Expand Your App’s Ecosystem

As an app developer, you understand the value of making your app accessible across multiple platforms. With viaSocket’s Plugin builder, you can easily integrate your app into the viaSocket ecosystem, making it available to a broad audience.

Why Integrate with viaSocket?

• Wider Reach: By bringing your app into viaSocket, you tap into a diverse user base, increasing your app’s visibility and usage.
• Custom Workflows: Allow users to create custom workflows that incorporate your app, enhancing its utility and user engagement.
• Ease of Integration: The Plugin builder simplifies the integration process, even if your app has complex functionalities.

Example Use Case - Imagine integrating a project management tool with viaSocket, enabling users to automate task creation, status updates, and notifications directly within their workflows.

For Individual Users: Bring Your Favorite Apps to viaSocket

Are you using an app that isn't yet available on viaSocket? With the Plugin builder, you can bring your favorite apps into the platform, provided the app’s API is publicly accessible. This feature allows you to create custom automations and workflows tailored to your needs.

Why Use the Plugin Builder?

• PersonalizedAutomation: Tailor workflows to fit your specific needs by integrating the apps you love.
• NoCodingRequired: The Plugin builder is user-friendly, making it accessible even if you don’t have a technical background.
• EnhancedProductivity: Automate repetitive tasks, streamline processes, and save time by connecting your apps within viaSocket.

Example Use Case - If you use a messaging app like Slack that isn’t pre-integrated, you can bring it into viaSocket using the Plugin builder. You could then set up a workflow that sends notifications to Slack when specific events occur in another app.

How to Get Started

• Access the Plugin Builder: Log in to viaSocket and navigate to the Plugin builder In Developers Hub.
• Define Visibility Configuration: Set the visibility of your integration, determining whether it is public or restricted to certain users.
• Define Authentication: Configure the authentication method for your app integration, such as API keys or OAuth.
• Define Triggers and Actions: Set up the events (triggers) that will initiate workflows and the tasks (actions) that will be performed in response.
• Testing and Customization: Thoroughly test your integration to ensure it functions correctly, and make any necessary customizations.
• Deploy and Use: Once tested, deploy your integration and start using it to automate tasks and enhance your workflows.

With the ability to integrate virtually any app, viaSocket enables you to unlock new possibilities and streamline your processes like never before.

viaSocket's Plugin builder allows you to create custom integrations between your favorite apps and the viaSocket platform. This detailed guide will walk you through each step of the process, from initial setup to deployment, ensuring you can create powerful and efficient workflows tailored to your needs.

The following steps will guide you through creating a plugin in viaSocket.

1. Visibility Configuration

2. Authentication

3. Create Triggers

4. Create Actions

5.  Define Input Fields

AI Assistance at every step

​viaSocket’s AI is designed to make the plug creation process as simple and efficient as possible. At each step, the AI provides valuable support, such as automatically fetching the icon of an app when you provide its domain and recommending most useful triggers and actions based on your needs.

Access the Plugin Builder

• Navigate to the Developer Hub section.

• Click on the Plugin Builder option.

• Once inside the Plugin Builder, select "+Create New Plug" to begin creating your custom plug.

1.  Visibility Configuration

This includes choosing a unique and descriptive name, uploading a relevant logo for display in viaSocket's app library, and deciding on the plugin's audience. You can set your plugin to Private, making it available only to your account or organization, or Public, which allows it to be listed in viaSocket's "Integration" library for access by all users.​

2. Authentication

• Basic Authentication: Requires users to enter an API key or username and password.

• OAuth 2.0: Involves providing a client ID, client secret, authorization URL, and token URL for more secure and scalable access.

The choice of authentication method depends on the specific requirements of the app being integrated.

3. Create Triggers

• Instant Triggers: These use webhooks to initiate workflows instantly when an event occurs in the integrated app.

• Scheduled Triggers: These use APIs to poll data at regular intervals, such as every 15 minutes, to check for updates and trigger workflows accordingly.

 For example, "New Email Received" in an email app or "New Order Created" in an e-commerce platform.

4. Create Actions

For example, "Send a Message" in a messaging app or "Update a Record" in a CRM system.

​

5. Define Input Fields

• Input fields are the parameters that users need to provide to execute triggers or actions.

• Clearly define the input fields, including their names, data types (text, number, date, etc.), and validation rules.

• Ensure that all required fields are clearly marked, and optional fields are identified accordingly.

Testing and Deployment

• Test Your Plugin: Before deploying, thoroughly test your plugin to ensure all triggers, actions, and authentication methods work correctly. Use the "Test" feature in viaSocket to simulate various scenarios.

• Publish Your Plugin: Once your plugin is tested and customized, click "Publish" to make it live. Choose whether to keep it private or make it public on the viaSocket.

Monitor and Maintain: After deployment, monitor your plugin's performance through the viaSocket dashboard. Update and maintain your plugin regularly to fix bugs, add new features, or improve performance based on user feedback.

Creating a plugin in viaSocket is a powerful way to extend the capabilities of your apps and automate workflows. By following this step-by-step guide, you can create robust and efficient integrations tailored to your specific needs, enhancing productivity and streamlining processes.

Steps to configure Visibility Configuration:

Specify App Name and Domain

Once you click on "+Create New Plug," you will be prompted to provide the App Name and Domain in the correct format.

• App Name: Enter the name of the service for which you want to create a plugin.

  • Example: If you are creating a plug for MailChimp, type "MailChimp."

• Domain: Enter the domain of the app, which is the official website or URL of the application.

  • Example: For MailChimp, enter "mailchimp.com."

AI Assistance in Visibility Configuration

When you provide the App Name and Domain while creating a plug in viaSocket, our AI automatically fetches all the necessary details for the visibility configuration, such as the app description, logo, category, and more. This saves time and ensures accuracy. You can then review these details and make any changes as needed to align with your specific requirements. This process simplifies setting up your plug and optimizes it for visibility and engagement on viaSocket.

Required Details for Visibility Configuration

Below is the list of details you need to provide and adjust during the Visibility Configuration step:

1. App Name: Enter the name of the service you wish to create a plugin for.
   • Example: "MailChimp" if you are creating a plug for MailChimp.
2. App Description: Provide a detailed description of the service, including what it does and where it can be used.
   • Example: "MailChimp is a leading email marketing service that allows businesses to create, send, and analyze email campaigns. It offers a range of tools for designing emails, managing subscriber lists, and tracking campaign performance."
3. Domain: Enter the domain of the app. This is the website or URL associated with the application.
   • Example: "mailchimp.com"
4. Audience: Indicate whether the plugin is public or private.
   • Private: Only people within the creator’s workspace can access and use the plug.
   • Public: The plug is available for all viaSocket users to access and utilize.
5. Category: Select the category that best describes your plugin. viaSocket provides a list of categories for various types of applications. 
6. Icon URL: Specify the URL for the icon of your plugin. If the correct domain is entered in the previous step, viaSocket will automatically set the icon URL.
7. Tags/Keywords: Add relevant tags or keywords to enhance the searchability of your plugin within viaSocket.
8. App’s Primary Color: Specify the primary color of the app. This helps in better visual integration of your plug within the viaSocket interface.
9. Whitelist URL: Include the base URL of the service API. This is crucial for making API requests.
   • Example: "https://api.mailchimp.com/3.0/"
10. Requires Fixed IP Checkbox: Check this box if your application requires a dedicated IP for making API calls. If selected, viaSocket will provide the necessary IP details for whitelisting purposes.

Importance of Visibility Configuration

Visibility Configuration is a crucial step when creating a plugin (plug) in viaSocket, especially if you choose to make your plug public. The settings and details you provide during this step determine how your plug will be displayed and accessed by users within the viaSocket platform.

Why Visibility Configuration Matters

1. Enhanced Discoverability in the App Library
   For public plugs, visibility configuration directly impacts their presence in viaSocket's app library, accessible at viasocket.com/integrations. This library is a central hub where users can browse and discover various integrations available on viaSocket. By setting your plug’s visibility to public, it becomes part of this app library, enhancing its discoverability among all viaSocket users.

2. Dedicated Web Page for Public Plugs
   When you make your plug public, viaSocket not only lists it in the app library but also creates a dedicated page for your plug on its website. This page provides detailed information about your plug, helping potential users understand its functionality and benefits. The URL for this page follows the format:
   viasocket.com/integrations/[AppName].
   • Example: If your plug is for MailChimp, the URL would be:
     viasocket.com/integrations/MailChimp

3. Utilization of Plug Details for Web Page Content
   The information you specify during the Visibility Configuration step is crucial because it is used to populate the content of the dedicated web page for your public plug. This includes:

   • App Name: The name of your app or service, helping users quickly identify the plug.

   • Logo: The visual representation of your app, enhancing brand recognition.

   • Category: Helps categorize your plug in the app library, making it easier for users to find it under the appropriate category.

   • About App: A detailed description of what your app does, its key features, and the problems it solves. This section informs users about the benefits of integrating with your app.

   • Redirection to Your Website: A link that directs users from the viaSocket page to your app's website, potentially driving traffic and increasing user engagement.

4. Consistent and Custom Branding with App’s Primary Color
   To enhance the visual identity of your plug, viaSocket uses the primary color provided by you during the visibility configuration on the dedicated page for your public plug. This allows the page to reflect your brand’s color scheme, ensuring a unique and cohesive presentation that aligns with your app’s branding.

Benefits of Proper Visibility Configuration

• Increased User Engagement: By making your plug public and configuring its visibility correctly, you enhance its visibility and appeal, potentially leading to increased user engagement and adoption.

• Improved Marketing Opportunities: The dedicated web page serves as a marketing tool, promoting your app to a broader audience and providing a platform to highlight its key features and benefits.

• Greater Reach and Exposure: Public plugs in viaSocket benefit from being part of a centralized app library, making it easier for users to discover and use your app, thus expanding your reach within the viaSocket community.

Visibility Configuration is not just a technical step but a strategic one that affects how your plug is presented to and perceived by viaSocket users. For public plugs, proper visibility configuration ensures that your plug is prominently displayed in the app library and has a dedicated web page that accurately represents your app. By carefully providing the necessary details, including your app’s primary color, you maximize the visibility and impact of your plug within viaSocket, enhancing both discoverability and user engagement.

Private vs Public Plugs in viaSocket

When configuring the visibility of your plug in viaSocket, you have the option to choose between making it Private or Public. Understanding the difference between these options is crucial for determining how your plug will be accessed and utilized.

Private Plugs

• Visibility: Private plugs are only visible within your workspace.

• Access: Only you and members of your workspace can see and use the plug.

• Use Case: Ideal for internal tools or integrations that are specific to your team or organization.

Public Plugs

• Visibility: Public plugs are available to all users of viaSocket.

• Access: Any viaSocket user can discover and use the plug.

• Additional Exposure:

  • Your plug will be listed in the viaSocket app library, increasing its visibility to a broader audience.

  • A dedicated page for your app will be created on the viaSocket website, with a URL in the format: viasocket.com/integrations/[AppName].

• Use Case: Best suited for widely applicable tools or services that you want to share with all viaSocket users.

Benefits of Using Public Plugs

• Increased Exposure: Public plugs gain visibility across the entire viaSocket user base, potentially attracting more users to your service.

• Marketing and Branding: The dedicated page on the viaSocket website serves as a marketing tool, showcasing your app and its features to a broader audience.

• Community Engagement: Encourages engagement and collaboration within the viaSocket community, allowing more users to benefit from your integration.

Choosing between a private and public plug depends on your goals and the intended audience for your integration.

Next Steps

After completing the Visibility Configuration, you will proceed to the next steps of creating a plug, including Authentication and Actions & Triggers. These steps will further define the functionality of your custom integrations, allowing you to maximize the potential of your app within viaSocket.

For more detailed guidance on each step, refer to the specific documentation sections on Authentication and Actions & Triggers.

Next step to set authentication for your plugin. In Authentication Configuration viasocket provide three types of authentication methods for your application :

• No Auth

• Basic Auth

• OAuth 2.0 (viaSocket supports the types of authentication in OAuth 2.0: Authorization Code, Implicit, Client Credentials, Password Credentials)

Typically, 'No Auth' is used when the service does not require authentication to access its API. This is commonly applicable for open APIs. 

Typically, basic authentication requires the service's api-key. The processes to obtain an API key and the necessary fields are covered in detail in the service's documentation. Click here to know how basic auth works in viaSocket.

Auth2.0 works by delegating user authentication to the service that hosts the user account and authorizing third-party applications to access the user account. 

Type 1: Authorization Code

To implement OAuth 2.0 (Authorization Code) for a particular service, you typically need to register your application with the service to obtain a client ID and client secret, set up redirection endpoints to handle callbacks, and create logic to obtain and refresh access tokens using the client credentials. Click here to learn more about Authorization code.

Type 2: Implicit Auth

Implicit authentication, an OAuth 2.0 grant type, enables the client application to receive the access token directly from the authorization server via the redirection URI, without needing an intermediate authorization code, using only the client ID. Click here to learn more about Implicit auth in viaSocket.

Type 3: Client Credentials 

The Client Credentials grant type in OAuth 2.0 uses a client ID and secret to get an access token. Register with the OAuth 2.0 provider to receive these credentials. Upon successful authentication, the server issues an access token. Click here for more details.

Type 4 : Password Credentials

This OAuth 2.0 grant type exchanges a user's username and password directly for an access token. Register your application with the OAuth 2.0 authorization server to obtain a client ID and client secret. To learn more about password credentials authentication type in viaSocket Click here.

Test Me API: 

To complete the process of authentication the final step is to add the Test Me API . It is a simple GET API which is getting user details, profile information.This API is invoked during the authentication process of the plugin.

Sample Request with Response:

                 
Connection Label: 

It is a label provided to show authentication by the user when using the plugin in any of the flows. For security  purposes, "Mask connection label value"  is used to essentially conceal the actual value of the connection label. 

Append Headers/Query params/Body: The interface you are looking at allows you to set default key-value pairs for headers, query parameters, or the body of HTTP requests where you want to send authentication data. These defaults will be applied to all actions or triggers that use the specified authentication version, ensuring consistent and necessary data is sent with each request. 

Suppose your API accepts api-key the query params and, so add Key: api-key (or the specific syntax required by your service) Value: The authentication key entered by users  

Now in any action and trigger no need to add authentication in any api it will fetch automatically

For further assistance, visit the viaSocket support page or contact our support team at support@viasocket.com.

• Version of authentication: Viasocket provides v1 version of authentication automatically.

• Field Label : Viasocket provides field auth_key by default for basic auth, but one can add additional fields accordingly.

Configure additional Input Fields (if required) :

Click on Add Field and fill the field details

• Key: Uniquely identifies the input field. It is essential for referencing and processing the data associated with this field.Ex: auth_key , domain.

• Label: The name of the field. It will be visible on the UI. This is what users will see as the name of the input field.

• Help : Provide any instruction to the user such as:documentation link,format etc.

• Type: Specifies the data type of the field, such as string for text, number for numeric values, etc. As of now it is set to string.

• Required: Indicates whether the field is obligatory. If checked, users must provide a value for this field during authentication.

Auth2.0 works by delegating user authentication to the service that hosts the user account and authorizing third-party applications to access the user account. 

Type01: Authorization Code

To implement OAuth 2.0 (Authorization Code) for a particular service, you would typically need to register your application with the service to obtain a client ID and client secret, implement redirection endpoints for handling callbacks, and implement the logic to obtain and refresh access tokens using the client credentials.

Scopes : Scopes define and limit the access that a client application has to a user's resources on a resource server. They play a crucial role in determining the extent of the authorization granted during the OAuth flow. 

There are two types scopes :

• Space Separated : In some OAuth 2.0 implementations, scopes are represented as a space-separated list within the scope parameter. For example: scope=read write profile
• Comma Separated : In other OAuth 2.0 implementations, scopes are represented as a comma-separated list within the scope parameter. For example: scope=read, write, profile.

Next step is to add required API’s and authenticate a user, the API’s you need to provide for your service is: 

Access Token API :

Once the authorization code is generated, the next step is obtaining an access token. The primary purpose of an access token is to securely grant limited access to specific resources on behalf of a user or an application.

Example : 

Refresh Token API :

The refresh token serves to refresh the validity of the access token by generating a new token and extending the access token's duration.

Example : 

Revoke Token API :

If you wish to disable an access or refresh token, simply send a request to the /revoke endpoint of the appropriate authorization server.

Example : 

Test Me API :

Same as basic auth

Example :

Append Headers/Query params/Body: 

The interface you are looking at allows you to set default key-value pairs for headers, query parameters, or the body of HTTP requests where you want to send authentication data. These defaults will be applied to all actions or triggers that use the specified authentication version, ensuring consistent and necessary data is sent with each request. 

Support your API accepts api-key the query params and, so add Key: api-key (or the specific syntax required by your service) Value: The authentication key entered by users  

Now in any action and trigger no need to add authentication in any api it will fetch automatically.
 

The client application receives the access token directly from the authorization server as part of the redirection URI without an intermediate authorization code with client ID  only.

 The Client Credentials grant type in OAuth 2.0 is used to obtain an access token with users' client ID and secret. 

• Client application is registered with the OAuth 2.0 service provider. 

• During registration, the client receives a Client ID and a Client Secret.

• If the authentication is successful, the server issues an access token to the client application

🔴All other fields(Authorization URL, Scopes, response type, additional fields) and API’s (Access Token API, Refresh Token,Test Me API, Connection label) are the same as described above authorization code .

This grant type in OAuth 2.0 involves exchanging a user's username and password directly for an access token.

• Register your application with the OAuth 2.0 authorization server to obtain a client ID and client Secret.

A trigger is an event that initiates your automated workflow, serving as the catalyst for a series of predefined actions whenever a specific event occurs. 

• Instant Triggers 

• Scheduled Triggers. 

This documentation will guide you through the process of creating and managing these triggers.

Instant Triggers are designed to respond immediately to specific events or conditions. When the criteria for the trigger are met, the associated actions or processes are executed without delay. This type of trigger is ideal for real-time responses, such as sending notifications or updating records as soon as a change occurs.

Next step is to add required API’s for create instant trigger, the API’s you need to provide for your service is: 

Add PerformList  API

Example:

Add Perform Subscribe API:

Example : 

ADD PerformUn-Subscribe  API:

Example : 

Scheduled Triggers are designed to activate at predetermined times or intervals. Unlike instant triggers, which respond immediately to events, scheduled triggers run based on a schedule you set. This is useful for tasks like periodic data synchronization, regular report generation, or routine maintenance activities.

Add PerformList  API

Example : 

Add Perform  API

Example : 

For further assistance, visit the viaSocket support page or contact our support team at support@viasocket.com.

Actions are specific tasks or operations executed as part of an automated process. These tasks are triggered by certain events or conditions and can range from simple data manipulations to complex API interactions. Actions are fundamental to automating workflows, allowing seamless integration and interaction between different applications.

Add additionally required scopes

To perform the particular action if any other scopes is required enter it in the action scopes.

Now we have to write Action JSON:

The concept of "action JSON" in a viaSocket plugin refers to the structured JSON format used to define the fields of an action that are selected by the user when he/she uses that plugin. This JSON structure typically includes text fields,dropdowns, input groups etc .

Here is a simplified version of what an action JSON might look like : 

Perform API:

The last step to complete the action is to add a final perform API. This API is responsible for performing the action. For detailed explanation Click here. 

Example : 

For further assistance, visit the viaSocket support page or contact our support team at support@viasocket.com.

• Defining Input Fields: JSON is used to specify the fields that users will fill out. Each field is represented as a key-value pair with attributes that describe the field.

• Specifying Field Attributes: Attributes include the field’s name, label, type, required status, and more. These attributes guide how the form will look and function within the plugin’s interface.

viaSocket GUI  : The GUI functions like other form builders, creating forms within the Platform UI. Add fields to the form matching the data required by your app, using the same names as in your app’s UI.

This guide covers:

 Adding Input Fields in JSON:

• Define the structure and attributes of input fields using JSON.

Adding Fields through GUI:

• Use the GUI to add and configure input fields seamlessly within the platform.

Adding Input Fields in JSON:

• Log into the viaSocket. 

• Select the org in which you want to create app integration.

• Go to the Developer hub and click on the ‘new plug’ button.

• A json structure with default input fields will appear (as shown above), you can edit these fields according to plugin needs. In JSON editor, add in details about your input field,JSON input field attributes are:

key: A unique identifier for the field. It should be concise, without spaces, and ideally match the key for each field, used to send data in API , such as ‘username’.

Label: A name or label visible on the UI for the field, such as "Name".

type: Defines the type of input field, such as string, number, dropdown, input groups, etc. Refer to the plugin input fields documentation for more details on types.

help (optional): A longer description that appears under the field, with markdown formatting support .For example “Enter or select Account username”.

placeholder (optional): A placeholder for a field, shown inside the input field for example text. This can be used as an alternative to help text.

required :  Indicates whether the field is mandatory. If the key is not provided, it defaults to false. If the field is required by the API and users must provide a value, set it to true.

Source:  In case of dynamic data in the field a new JSON key is added “source”. Specifies the source of the data for the field, such as a URL or API endpoint. Discussed in advance input fields section

children:  Similarly a new key required in case of dropdown,input groups which   hold child elements of fields. Explained in advance input fields section

Adding Input Fields using GUI:

• Log into the viaSocket.

• Select the org in which you want to create app integration.

• Go to the Developer hub and click on the ‘new plug’ button.

• Switch to the GUI tab. Select type of field you want to add :

• Add the field required and to edit the field click on setting button (Editing in GUI also reflect in JSON automatically)

• Edit all attributes of field

• Remember to save changes after every change in fields.

string : 

number: 

Static input group: 

When designing APIs or building user interfaces that interact with APIs, it's crucial to inform users about default values, especially if these defaults may impact the behavior of the system or the data processing. User can edit this default value

For string/number/boolean 

For dropdown

Multiselect values with static children  

Multiselect values with dynamic children refer to a feature in dropdown menus where the options available for selection change based on API. For this JSON looks the same but a new key is added called “source”.

The source API includes a JavaScript call to fetch the required data. Once retrieved, the data is shown in the dropdown as an array of objects, each containing a label, sample, and value for the child options. Example  : If you want to create sites multiselect dropdown for webflow application so this is what you have to integrate:

• Take a get API for get all sites from webflow API documentation

• Configure it in javascript API call code 

• Return a object containing label,sample,value for all sites 

• This code can be added through the GUI or via JSON by including a key "source" with the escaped code as its value.Use EscapeJSON to properly format the code for JSON.

Response : 

On selecting multiple value from the dropdown, it returns an array of that field and comma separated values in it. To use this value in the entire action , the path is ${context.inputData.fieldName} : 

We are excited to invite you to integrate and test your app on viaSocket, a powerful workflow automation tool. 

1. Sign Up: Create an account on viaSocket.
2. Promo Code: Use the promo code provided by us to access premium features.
3. Test Your Integration:

• When - Trigger: Test how your app initiates workflows.
• Do - Action: Test how your app responds within workflows.

For instance, if your app is an email marketing tool, you might test triggers like “New Subscriber” and actions like “Send Welcome Email.”

Testing Triggers

• Search Your App: Look for your app on our “App Integrations” page. Verify that your app’s name and logo are correct.
• Select Trigger: Choose the trigger you want to test first.
• Authentication: Ensure that all triggers have the correct type of authentication.
• Description: Check the description of each trigger to ensure accuracy.
• Fields Verification: Verify all the fields in each trigger.
• API Response: Check the APIs' responses in the response block.
• Testing Multiple Triggers: You can test all your triggers from the same flow by clicking on “Change” beside the trigger name in the slider. Once authenticated, you can continue with the same authentication.
• Further Testing: Use any of our in-built tools or your own app’s actions to test further.

Testing Actions

• Create a Flow: Start with a Webhook or Cron as the trigger. You can also use your own app's triggers.
• Select Action: Choose the action you want to test first.
• Authentication: Ensure that all actions have the correct type of authentication.
• Description: Check the description of each action to ensure accuracy.
• Fields Verification: Verify all the fields in each action.
• API Response: Check the APIs' responses in the response block.
• Testing Multiple Actions: Continue adding all the actions of your app in the same flow. Once authenticated, you can continue with the same authentication.

After you’ve tested your integration, you might have suggestions for improvements or additional Triggers and Actions you want to implement.

Please reach out to us at plugs@viasocket.com with your feedback and requests.

We’re committed to showcasing our integrations prominently. Once your integration is verified, we will feature your app on our website at viaSocket Integrations. 

We will also create a dedicated page for your app at viaSocket/integrations/[your_app].

For example, https://viasocket.com/integrations/emailoctopus.

We know that showcasing real-world applications of your integration is vital. On your app's dedicated page, we will feature popular use cases. We invite you to share with us the combinations and use cases you want highlighted. You can email these details to us, and we will ensure they are prominently displayed.

Our promotional efforts extend beyond our website. We actively post about new integrations and popular use cases on social media and include them in our email newsletters. If you have specific use cases you want us to promote, let us know, and we will include them in our communications. Additionally, we can provide you with images and content to share with your own audience.

Once you have completed the testing and verification, we will publish your app on our tool and website.

Thank you for partnering with us. We look forward to seeing the innovative ways in which your app can integrate with viaSocket.

For any queries, feel free to contact us at plugs@viasocket.com.

Let's make automation smarter together! 🚀

For example if creating a action “new entry” in Google Sheets plugin, the Final Perform API will:

1. Collect data from the input form. The input fields which are created from JSON or GUI we have to collect the data and send it in the api where needed using ${context.inputData.fielfName}.

For example: If Json Have fields username,email,phone to access them in final perform API use field key.

2. In google API docs a API is defined to create a new record in the sheet, make javascript code for that API call and Send above collected data to the Google Sheets API. For include authentication use: ${context.authData.access_token/fieldName}

Include input fields use : ${context.inputData.fieldName}

3. Save the API code. For Testing the Api you can run code by clicking the “Test” button. Viasocket also provide option to optimize your code you can optimize your code by clicking “optimize” button

• The JSON for creating a dictionary field includes a new keyword “template”, which defines the structure of key-value pairs. Key objects hold attributes for the left pair and value is for the right pair.

• Return a object containing key and value for given pairs 

• key is used to access this specific column value ex: ${context.inputData.dictionaryName.key}

• Take a get API for get all columns from airtable API documentation

• Configure it in javascript API call code 

• Return an array containing a object containing key,label,type,help for columns 

• 

  key is used to access this specific column value ex: ${context.inputData.inputgroupName.coloumnName}

• Label shown on the UI

• 

  type decide type of the field using if condition in input group source code you can change type for a field also

• help text can be static or dynamic. Handle source code

• This code can be added through the GUI or via JSON by including a key “source” with the escaped code as its value. Use EscapeJSON to properly format the code for JSON.

Response : 

it returns a key-value pair. If the key for the column is "name", the returned value will be in the format {site: "site_id"}. To use this value, the path is ${context.inputData.inputgroupName.coloumnName}: 

A dynamic dropdown updates its options in real-time based on user interactions or API. The values are fetched from an API using a JavaScript call, and the data is displayed as an array of objects, each containing a label, sample, and value. (Dropdown allows only single value to select)

The source API includes a JavaScript call to fetch the required data. Once retrieved, the data is shown in the dropdown as an array of objects, each containing a label, sample, and value for the child options. Example  : If you want to create sites dropdown for webflow application so this is what you have to integrate :

• Take a get API for get all sites from webflow API documentation

• Configure it in javascript API call code 

• Return a object containing label,sample,value for all sites 

• This code can be added through the GUI or via JSON by including a key “source” with the escaped code as its value. Use EscapeJSON to properly format the code for JSON.

Response : 

On selecting a value from the dropdown, it returns a key-value pair. If the key for sites is "site", the returned value will be in the format {site: "site_id"}. To use this value, the path is ${context.inputData.site} : 

Hidden Fields: Use the “hidefields”type to make fields invisible while passing necessary data.

Conditional Hidden Fields: Use “fieldsToHide”to hide fields based on conditions from other fields.

Dropdown Children: Condition applicable on dropdown children. If nothing is selected in the dropdown all the fields are visible to the user.

Show fields based on selected field:

If you want to make an app for viaSocket or you want to call its API then you may need its authentication.

This client ID and secret are organisation wise. Every organisation gets one unique client id.

ORG id - Get it from URL like

title - Name of your Auth, could be anything.

To make this API work, login and then click on Run.

NEXT Step (Authorization URL) - 

https://flow.viasocket.com?client_id={client_id}&scope=all&redirect_uri={redirectUrl}&response_type=code

we will redirect to your redirect URL with Access token redirect_URL?code=<code>&any additional query param found in above url

Whitelist redirect URL at viasocket

https://techdoc.viasocket.com/p/0WvNcdDId/e/ei1ucyviF/Viasocket

Next (Token URL) ->

https://dev-api.viasocket.com/oauth/v1/token

Detail documentation 
https://techdoc.viasocket.com/p/0WvNcdDId/e/hiAA0hsMf/Viasocket

You call our backend API from your backend with Client secret to generate Access token