Trigger Highrise IFTTT Flows in Azure App Service

Through standards-based interfaces like OData and Swagger, the CData API Server, when paired with the ADO.NET Provider for Highrise (or any of 200+ other ADO.NET Providers), provides a native experience in Logic Apps and Power Automate with Highrise. 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 Highrise to an IFTTT (if-this-then-that) workflow in a Logic App.

Set Up the API Server

Follow the steps below to begin producing secure and Swagger-enabled Highrise APIs:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to Highrise

After you deploy the API Server and the ADO.NET Provider for Highrise, provide authentication values and other connection properties by clicking Settings -> Connections and adding a new connection in the API Server administration console. You can then choose the entities you want to allow the API Server access to by clicking Settings -> Resources.

Highrise uses the OAuth authentication standard. To authenticate to Highrise, you will need to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL by registering an app with Highrise. You will also need to set the AccountId to connect to data.

See the "Getting Started" section in the help documentation for a guide to using OAuth.

You will also need to enable CORS and define the following sections on the Settings -> Server page. As an alternative, you can select the option to allow all domains without '*'.

1. Access-Control-Allow-Origin: Set this to a value of '*'. An Access-Control-Allow-Origin header value of '*' is required to use the API Server in the Logic Apps Designer.
2. Access-Control-Allow-Methods: Set this to a value of "GET,PUT,POST,OPTIONS".
3. Access-Control-Allow-Headers: Set this to "x-ms-client-request-id, authorization, content-type".

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. You can authenticate as well as encrypt connections with SSL. Access can also be restricted by IP address; access is restricted to only the local machine by default.

For simplicity, we will allow the authtoken for API users to be passed in the URL. You will need to add a setting in the Application section of the settings.cfg file, located in the data directory. On Windows, this is the app_data subfolder in the application root. In the Java edition, the location of the data directory depends on your operation system:

1. Windows: C:\ProgramData\CData
2. Unix or Mac OS X: ~/cdata

Access Highrise in a Logic App

You can use the API Server in a Logic App to create process flows around Highrise data. The HTTP + Swagger action provides a wizard to define the operations you want to execute to Highrise. The following steps below show how to retrieve Highrise 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 Highrise Entities

To find new Highrise 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 Highrise to a Trigger

Follow the steps below to create a trigger that searches Highrise 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 Highrise 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 Deals" 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:

   GroupId eq 'MyGroupId'

   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 Deals table and select the Body parameter in the dialog. Note that quotes must be used to surround the datetime value.

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/Deals"
      }
    

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

Email New Records

Follow the steps below to email a report with any new Deals 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 Highrise columns returned.

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