Trigger Square IFTTT Flows in Azure App Service

Through standards-based interfaces like OData and Swagger, the CData API Server provides a native experience in Logic Apps and Power Automate with Square. OData enables real-time connectivity to data; Swagger enables scaffolding, or code generation, of wizards in Logic Apps and Power Automate, as well as scaffolding Power Apps. This article shows how to add Square to an IFTTT (if-this-then-that) workflow in a Logic App.

Set Up the API Server

If you have not already done so, download the CData API Server. Once you have installed the API Server, follow the steps below to begin producing secure Square OData services:

Connect to Square

To work with Square data in a Logic App, we start by creating and configuring a Square connection. Follow the steps below to configure the API Server to connect to Square data:

1. First, navigate to the Connections page.
2. Click Add Connection and then search for and select the Square connection. 👁 Selecting a data source (SQLite is shown)
   
3. Enter the necessary authentication properties to connect to Square.

   Square uses the OAuth authentication standard. To authenticate using OAuth, register an app with Square to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

   Additionally, you must specify the LocationId. You can retrieve the Ids for your Locations by querying the Locations table. Alternatively, you can set the LocationId in the search criteria of your query.

   👁 Connecting to a datasource (SQLite is shown)
   
4. After configuring the connection, click Save & Test to confirm a successful connection.

Configure API Server Users

Next, create a user to access your Square data through the API Server. You can add and configure users on the Users page. Follow the steps below to configure and create a user:

1. On the Users page, click Add User to open the Add User dialog.
2. Next, set the Role, Username, and Privileges properties and then click Add User. 👁 Configure a new user
   
3. An Authtoken is then generated for the user. You can find the Authtoken and other information for each user on the Users page: 👁 API Server user settings
   

Creating API Endpoints for Square

Having created a user, you are ready to create API endpoints for the Square tables:

1. First, navigate to the API page and then click Add Table . 👁 Add tables
   
2. Select the connection you wish to access and click Next. 👁 Select the connection (SQLite is shown)
   
3. With the connection selected, create endpoints by selecting each table and then clicking Confirm. 👁 Adding tables from the connection (SQLite is shown)
   

Gather the OData Url

Having configured a connection to Square data, created a user, and added resources to the API Server, you now have an easily accessible REST API based on the OData protocol for those resources. From the API page in API Server, you can view and copy the API Endpoints for the API:

👁 API Endpoints

Access Square in a Logic App

You can use the API Server in a Logic App to create process flows around Square data. The HTTP + Swagger action provides a wizard to define the operations you want to execute to Square. The following steps below show how to retrieve Square data in a Logic App.

If your table has a column containing the creation date of a record, you can follow the steps below to write a function to check the column values for any new records. Otherwise, skip to the Create a Logic App section to send out emails to entities that match a filter.

Check for New Square Entities

To find new Square entities since a certain time, you can write a function that retrieves a datetime value for the start of the interval:

1. In the Azure Portal, click New -> Function App -> Create.
2. Enter a name and select the subscription, resource group, App Service plan, and storage account.
3. Select your Function App and select the Webhook + API scenario.
4. Select the language. This article uses JavaScript.
5. Add the following code to return the previous hour in a JSON object:

   module.exports = function (context, data) { 
    var d = new Date();
    d.setHours(d.getHours()-1); 
    // Response of the function to be used later.
    context.res = { 
    body: { 
    start: d 
    } 
    }; 
    context.done(); 
   };
   

Add Square to a Trigger

Follow the steps below to create a trigger that searches Square for results that match a filter. If you created the function above, you can search for objects that were created after the start of the interval returned.

1. In the Azure Portal, click New and in the Web + Mobile section select Logic App and select a resource group and App Service plan.
2. You can then use the wizards available in the Logic App Designer, which can be accessed from the settings blade for the Logic App. Select the Blank Logic App template.
3. Add a Recurrence action that will poll for the Square objects. This article polls every hour. Select the timezone -- the default is UTC.
4. Add a function action: Expand the menu in the Add Action dialog and select the option to show Azure functions in the same region. Select the Function App you created earlier and select the function that returns the interval start.
5. Enter an empty pair of curly brackets, "{}", to pass an empty payload object to the function.
6. Add the HTTP + Swagger action and enter the swagger URL of the API Server:

   http://MySite:MyPort/api.rsc/@MyAuthtoken/$oas

7. Select the "Return Refunds" operation.

8. Use the descriptions for each property to specify additional parameters such as the columns to retrieve, filters, etc. Below is an example filter:

   Type eq 'FULL'

   The API Server returns the descriptions and other documentation in the swagger document. You can find more information on using the OData API and supported OData in the API Server help documentation.

9. To use the datetime value returned from the getInterval function, use the "ge" operator with a datetime column in the Refunds table and select the Body parameter in the dialog. Note that quotes must be used to surround the datetime value.

   👁 An OData filter on the results of an Azure Function App, getToday. (Salesforce is shown.)
   

10. Switch to Code View and modify the $filter expression to extract the property containing the start of the interval. Use the syntax '@{body('MyFunc')['MyProp']'.

    "getAllAccount": {
     "inputs": {
     "method": "get",
     "queries": {
     "$filter": "CreatedDate ge '@{body('getInterval')['start']}'"
     },
     "uri": "https://MySite:MyPort/api.rsc/@MyAuthtoken/Refunds"
     }
    

You can now access Square as data sources and destinations in your workflows.

Email New Records

Follow the steps below to email a report with any new Refunds entities.

1. In the Logic Apps Designer, add an SMTP - Send Email action.
2. Configure the necessary information for the SMTP server.
3. Configure the From, To, Subject, and Body. You can add parameters from the Square columns returned.

Click Save and then click Run to send email notifications on any Square records created in the last hour.

👁 Dynamic columns added to template the body of an email. (Salesforce is shown.)