Skip to main content

Configuring a File Field in an Action

Fatima
  • Updated
The conventional method of transferring data from one app to another (using Integry) is via the HTTP requests, i.e., CRUD operations. As you must know, the Flows are designed in Integry based (mainly) on two events, a Trigger and an Action. A Flow is initiated when Integry receives a Trigger from a third-party application and is carried forward when Integry performs an Action in another third-party application - hence creating an integration between the two apps.
 
The way Integry receives data from one API and transfers data to another API is via an API Call using GET, POST, DELETE, and UPDATE methods. The data request is made at the REST API endpoint of an application. The endpoints can pass or receive data through the following ways:
  1. Header: The parameters are included in the request header
  2. URL: The parameters are appended in the URL
  3. Query String: The parameters are stored in a variable in a query string and are referenced to at the end of the request
  4. Request Body: Parameters are included in the request body, usually submitted as JSON. The JSON object may contain key-value pairs.
We use a JSON object in request body to transfer data to different endpoints. We support "raw" JSON structuring in Integry. However, some APIs expect to receive payload in a file format instead of a JSON object.
 
To send data in a file format, we need to structure the payload in multipart/form-data object. Multipart is an object to represent HTML form data. We can upload or transfer HTML form data in a file format to a server - using the multipart-upload HTTP request.
 
What makes multipart special is that an HTTP request such as FETCH can accept a FormData object as a message body. Multipart object is encoded and sent out with Content-Type: multipart/form-data.
 
For the scope of Integry, we'll have to convert a JSON object (received in a Trigger) into a FormData object (to upload a file in the action application). We can do that when we're configuring the Action in Integry.
 

Configuring a File Field in an Action

Let's assume that Integry receives payload at the Incoming webhook Trigger. The action application expects to receive a file containing that payload. This means that this payload has to be converted to a file at Integry level. The IU will design the Flow in the following way.
 
Step 1: Add a trigger that receives the payload.
Step 2: The next step in the Flow will be the File Append app. In this step, the payload from the Trigger will be converted to a file and save it on Integry's server.
 
 
Add a child step and select the File Append app from the app connector selection menu.
 
 
Step 3: Select the Append File Action.
 
 
Step 4: Configure the following fields of the File Append App.
  1. File Name: Enter your file name.
  2. Extension: Enter the file extension, e.g., txt, js, html, csv, png, pdf, etc.
  3. Data: Add a tag for the object in the trigger's payload that you want to append in your file.
Click on continue to test.
 
 
Step 5: The data encapsulated by the tag will be populated in this field. Click on Test to generate the file URL.
 
 
The file generated by the previous step can be viewed by visiting the URL shown in the response of the test result. Click on Done to continue.
 
Step 6: Add the Action step.
 
 
Here, you have to configure the field that receives the file URL. Click on the + button and click on Append File.
 
 
Add a file URL tag here and click on continue to test the action.
 
 
When you'll test the action, the URL will be sent to the action application (in this case, Marketo) and the file contents will be saved there. You can click on the URL (shown above) and verify the file content. Click on Done to save the Flow.
 
Now, your end-users can create an Integration where they can pass on content in a file format to any third-party application.