IFS Cloud

Documentation covers IFS Cloud version 24R2

This page will describe the nuances of configuring different parts of IFS Cloud to execute Automations within your Flow Connect environment. This guide will provide an example for:

• Custom Event Actions (REST)

• Work Flows

IFS Custom Event Action

To execute an automation, you must adhere to some specific requirements within IFS's Event Action screen.

1. The REST Endpoint must contain the Automation HTTP endpoint provided within the Automation configuration screen.

2. The Method should be "POST"

3. The Sender must be a configured REST Sender in IFS. (Default shown)

4. The Body must contain a JSON structure of any values you wish to send to your Automation. (Example provided below)

5. The Authentication must be "None".

6. Additional headers must be provided and are mandatory for Automations to execute:

   1. x-api-key:<AutomationAccessKey>

   2. Accept:*/*

//Example Header Value
//You must separate the header name and value with a colon.
//Any additional headers need to be separated with a comma.
//eg: "x-api-key" and "Accept" would be:

x-api-key:<myAccessKey>,Accept:*/*

//Example of a Body you can use to send the customer Id and Name to the Automation
//Note: The available IFS values are provided in the event page.
{
"CustomerId":"&OLD:CustomerId",
"name":"&NEW:NAME"
}

The IFS Additional Header parameter field accepts multiple headers separated by a comma.

You can now successfully trigger an automation directly from IFS Custom Events.

IFS Workflow Designer

To Execute an automation from an IFS Workflow you can simply define the required headers as follows:

1. Define the Authentication Type as "None"

2. Set The URL to an Automation webhook

3. Set the desired Method (POST)

4. Add the required headers:

   1. x-api-key: Automation access key

   2. Accept: Default is */* or application/json

   3. Content-Type: application/json or application/xml depending on body format

5. Define any required Body, in this example, JSON format.

You can now successfully trigger an automation directly from IFS workflows.