Info
Content
Home Document
⌘K
Version 1.0

PipeScripts

Overview

PipeScripts in Tadabase is a powerful feature designed to extend the capabilities of your applications by enabling dynamic server-side API calls. This allows developers to trigger complex actions directly from their client-side code, offering more flexibility and integration possibilities.

What are PipeScripts?

PipeScripts allow you to run server-side scripts that can interact with external APIs or perform complex computations. Unlike traditional API calls made from forms or action links within Tadabase, PipeScripts can be triggered directly from your custom JavaScript code, giving you the ability to seamlessly integrate external systems and data into your application.

Use Cases

PipeScripts can be utilized in a variety of scenarios, such as:

  • Integrating with third-party services like payment gateways, email services, or CRM systems.
  • Performing background data processing tasks without impacting the user experience.
  • Enhancing application capabilities with real-time data from external sources.

How Do PipeScripts Work?

Using PipeScripts is straightforward. Here’s a step-by-step guide on how to trigger a PipeScript from JavaScript:

Step 1: Prepare Your Pipe

First, set up your Pipe in Tadabase by defining the API endpoint and the parameters it requires. Each Pipe API Call is given a unique identifier which will be used to trigger it from your JavaScript code.

Step 2: Get the PipeScript Code:

In the Overview tab of the specific API call, click the Copy Code to get the unique code snippet to get started:

Step 3: Write Your JavaScript Code

Within your application, you can trigger the PipeScript using the following JavaScript function:

TB.triggerPipe(UNIQUE_PIPE_ID, {
    parameter_1_name: 'parameter_1_value', 
    parameter_2_name: 'parameter_2_value'
}, function(type, response, xhrResponse) {
    console.log('Pipe response:', type, response, xhrResponse);
});
  • UNIQUE_PIPE_ID: Replace this with the actual ID of your PipeScript.
  • parameters: These are the inputs that your PipeScript requires. Replace parameter_1_name and parameter_2_name with your parameter names and provide the corresponding values.

Step 3: Handle the Response

The callback function will execute once the API call is complete, allowing you to handle the response directly in your JavaScript. The function provides three arguments:

  • type: The type of response.
  • response: The data returned from the API.
  • xhrResponse: The full XMLHttpRequest response object, providing additional details about the API call.

Conclusion

PipeScripts offer a robust solution for developers looking to integrate advanced server-side functionalities into their Tadabase applications. By leveraging this feature, you can create more dynamic, responsive, and integrated web applications.

 

Back to top