Build (even more) on Yeeflow

Yeeflow team
Yeeflow team
  • Updated

Push the functionality of Yeeflow even further with custom tools to match your business needs.

If you’re a developer, or just interested in trying your hand at writing some code, Yeeflow’s custom scripting, web service call, and API allow you to stretch the limits of what your application can do.

 

1. Write custom scripts in Yeeflow

Custom scripts extend the functionality and flexibility of your Yeeflow application in a lightweight, low-code manner. You can use scripts build time-saving tools for repetitive jobs like data validation and batch records creation.

Scripts are small, easy to build snippets of code that execute a specific function. With the custom code controls, you can easily build custom tools, even if you don’t have a deep programming background. In this step, we’ll get into scripting basics, learn to use them, and see what they’re capable of.

 

What is scripting?

Scripts are small, easy to build snippets of code that execute specific functionality. With the Scripting extension, you can write, edit, and run short scripts to handle all sorts of tasks using JavaScript.

Scripting is particularly useful for programmatically validating data, creating batch records, deduplicating and merging redundant records, and scraping data.

With scripts, you can also connect third-party extensions that aren’t already integrated, and also create advanced formula functions.

 

Where can you program with custom scripts?

You can use the custom code control to run your custom scripts. The custom code control can be found from the Approval form designer, List form designer, and dashboard page designer which is under the group of Advanced.

 

form_controls_Custom_code.jpg

 

To add a custom code control, just click and drag this control onto the canvas. You can then paste the code script into the custom code block.

Custom_Code_Script.jpg

 

Another place where you can run your custom script is inside the Actions of the form/page designer. For example, when a page is loading, or a button is clicked, you can call the custom action, with multiple steps. There's one type of step call "Execute Script" which you can add to your action, and paste the custom code script in those steps. 

 

Custom_Code_Action.jpg 

 

How to program your custom code script?

Please refer the detail introduction about how to build and compile your code from: GitHub - Yeeflow/custom-code: Build your script for custom code control and action

 

There are also different type of samples which you can download and do practices. 

 

2. Using Yeeflow’s APIs

Go even further by using Yeeflow’s API, and connect your application to other apps and environments. The API allows your application to communicate with services not natively supported by Yeeflow, and gives you the ability to create, read, update, and delete records from almost any platform.

 

By diving into Yeeflow’s more advanced customization abilities, you can integrate your team’s outside services to Yeeflow, and read and write your application with outside tools.

 

What's possible with Yeeflow's API?

The API increases the cross-functionality of Yeeflow, allowing you to build integrations into other applications, or create standalone tools that can communicate with your application. Let’s explore three examples of how you could use the Yeeflow API in your work:

1. Create new records from yet to be supported platforms

If you use a calendar app or data recording tools that aren’t natively supported yet with Yeeflow, the API allows you to write new records from those sources. For example, when an event gets scheduled on a calendar, an equivalent record is added to a application.

2. Update records from a 3rd party platform

The API allows you to keep your application’s records up to date by pulling in information and status updates from outside platforms. So if you use Yeeflow to monitor the progress of a development project, and your team uses an outside tracking platform, you can build a custom tool for updating your application using the API.

3. Combination update and delete from a 3rd party platform

The API can also update existing application entries, and delete information that’s no longer needed. If you’re planning an event, you could use the API to update the location, even if it’s being organized on an outside platform.

 

Understanding your API key

Each Yeeflow account only has one API key. Before you can start using your API, you need to generate the unique API key for your account. This API key can only be managed by the System Admin of your Yeeflow account.  To manage the API key, firstly go to the admin center, and click the "Integrations" icon:

Admin_Integration.jpg

 

From the Integrations settings page, you can generate the API key, or if you've already created one API key, you can invoke, or regenerate a new API key:

Admin_API_Key.jpg

 

Important: Keep this API key secure, as it’s functionally a password that allows access to your applications.

 

You can use those APIs in your custom code script. Or, using the HTTP request workflow step from the workflow designer to call the Yeeflow's APIs.

 

Workflow_Dsigner_HTTP_Request.jpg

 

Try it now: Run an API event

Using Yeeflow's API documentation, you'll be able to explore the steps to setting up an API in any application in your account.

This documentation: Yeeflow APIs | Yeeflow Developer Site explains the functionality of the API, the tools you have access to and their limitations, and how to interact with the data in that specific application.

 

3. Integrated connectors for third-party platform

To integrate with 3rd-party system, besides the API call, you can also using the Yeeflow Connectors for Microsoft Power Automate, and connectors for Zapier.

 

Yeeflow Connector for Microsoft Power Automate

Please refer this documentation to learn how to use Yeeflow connector for Microsoft Power Automate to integrate with other systems: Microsoft Power Automate Integration - Yeeflow

 

Yeeflow Connector for Zapier

Please refer this documentation to learn how to use Yeeflow connector for Zapier to integrate with other systems: Using Zapier to connect Yeeflow with hundreds of other apps – Yeeflow Help Center

 

 

Was this article helpful?

/

Comments

0 comments

Please sign in to leave a comment.