Connecting Engini to ODATA
- Enter your Engini account at https://app.engini.io.
-
Navigate to Connections page by clicking on the Connections on the left side bar or by clicking here.

-
Click on the “New Integration” option located at the top bar.

-
Choose “OData” option from available applications.

- Enter the following details in the “New Integration” form and press Save:
Basic Auth
Use this method when your OData service accepts a user name and a password.
- Connection Name - Enter a name that helps identify the OData connection.
- Authentication Method - Select Basic Auth.
-
Url - Enter the root URL of your OData service, for example
https://example.com/odata/v4. - Username - Enter the user name used to authenticate with your OData service.
- Password - Enter the password of that user.
- Communication Channel - Choose how Engini connects to your OData service. Cloud is the default, for services reachable over the public internet. OPA is for services on a private network that Engini reaches through its On-Prem Agent (OPA).
-
Advanced settings - Expand this section to add extra HTTP headers that your OData service requires (a Key and a Value for each header) and to set whether Engini checks the server’s SSL certificate.

- Save - Click Save to create the connection.
Bearer Token
Use this method when your OData service accepts a bearer token that you already have.
- Connection Name - Enter a name that helps identify the OData connection.
- Authentication Method - Select Bearer Token.
-
Url - Enter the root URL of your OData service, for example
https://example.com/odata/v4. - Token - Enter the bearer token used to authenticate with your OData service. Engini sends it with every request. You usually get this token from your identity provider or authorization server.
- Communication Channel - Choose how Engini connects to your OData service. Cloud is the default, for services reachable over the public internet. OPA is for services on a private network that Engini reaches through its On-Prem Agent (OPA).
-
Advanced settings - Expand this section to add extra HTTP headers that your OData service requires (a Key and a Value for each header) and to set whether Engini checks the server’s SSL certificate.

- Save - Click Save to create the connection.
OAuth 1.0
OAuth 1.0 is an authentication protocol that allows secure access to APIs without sharing user passwords.

- Connection Name - Enter a name that helps identify the OData connection.
- Authentication Method - Select OAuth 1.0.
- Url - Enter the root URL of your OData service, for example
https://example.com/odata/v4. - Consumer Key - Enter the OAuth consumer key issued by your OData provider.
- Consumer Secret - Enter the matching consumer secret.
- Access Token - Enter the access token issued during the OAuth 1.0 flow.
- Verifier - Only if your OData service needs one: enter the verifier issued during authorization.
- Include Body Hash - Choose true to include a hash of the request body in the signature, if your provider requires it. The default is false.
- Add Empty Parameters to Signature - Choose true if your provider expects all parameters, even empty ones, to be signed. The default is false.
- Encode the Parameters Into Authorization Header - Choose whether the OAuth parameters are sent in the Authorization header. The default is true.
- Communication Channel - Choose how Engini connects to your OData service. Cloud is the default, for services reachable over the public internet. OPA is for services on a private network that Engini reaches through its On-Prem Agent (OPA).
- Advanced settings - Expand this section to add extra HTTP headers that your OData service requires (a Key and a Value for each header) and to set whether Engini checks the server’s SSL certificate.

Custom OAuth 2.0
OAuth 2.0 is a modern authorization protocol that allows secure access to APIs using access tokens instead of passwords. Use this method when users sign in through your own app registration at your identity provider.

- Connection Name - Enter a name that helps identify the OData connection.
- Authentication Method - Select Custom OAuth 2.0.
- Callback URL - A read-only field that shows the address your OData provider sends you back to after you sign in (
https://workflowapi.engini.io/api/auth/OAuthRedirectUrl). Click the copy button next to it, then register this address with your identity provider as the redirect URI of your app. Do this before you sign in, so that the sign-in works. - Url - Enter the root URL of your OData service, for example
https://example.com/odata/v4. - Token URL - Enter the endpoint your identity provider gives for retrieving access and refresh tokens, for example
https://login.example.com/oauth2/token. - Client Id - Enter the client (application) Id from your identity provider.
- Client Secret - Enter the secret that belongs to your client Id.
- Scope - Enter the permissions Engini requests from the provider, for example
openid offline_access. - Sign-in URL - Enter the authorization endpoint where users log in and approve access, for example
https://login.example.com/oauth2/authorize. - Communication Channel - Choose how Engini connects to your OData service. Cloud is the default, for services reachable over the public internet. OPA is for services on a private network that Engini reaches through its On-Prem Agent (OPA).
- Advanced settings - Expand this section to add extra HTTP headers that your OData service requires (a Key and a Value for each header) and to set whether Engini checks the server’s SSL certificate.

OAuth2 (No SignIn)
This method authenticates with OAuth 2.0 without a user login flow, using the client credentials of your app.

- Connection Name - Enter a name that helps identify the OData connection.
- Authentication Method - Select OAuth2 (No SignIn).
- Url - Enter the root URL of your OData service, for example
https://example.com/odata/v4. - Token URL - Enter the full URL of your identity provider’s token endpoint, for example
https://login.example.com/oauth2/token. - Client Id - Enter the client (application) Id from your identity provider.
- Client Secret - Enter the secret used to authenticate the client.
- Grant Type - Defaults to
client_credentials, the grant type used for this flow. - Scope - Enter the permissions Engini requests, for example
api://my-app/.default. - Communication Channel - Choose how Engini connects to your OData service. Cloud is the default, for services reachable over the public internet. OPA is for services on a private network that Engini reaches through its On-Prem Agent (OPA).
- Advanced settings - Expand this section to add extra HTTP headers that your OData service requires (a Key and a Value for each header) and to set whether Engini checks the server’s SSL certificate.

- Click on the three dots and then click on “Select database objects”.
- A window will open displaying all available entities and actions, just like when you saved your connection. From this window, select the new entities and actions you want to use.
Activities
Create Record
This activity adds a new record to a selected OData entity, letting you insert data like customers, orders, products, or other custom entities defined in your service.- Object Type- Select the target entity where the new record should be created. Only entities that were selected during the “Select Database Objects” step of the OData connection will appear here.
- Add Field - Click Add Field to add and populate additional fields for the selected activity. To learn more about managing activity data, click here.
Create Records Batch
This activity allows you to create multiple records for a specified OData entity in a single request.- Object Type- This field defines the target entity for all records in the batch. Its options are limited to the entities you previously chose in the “Select Database Objects” configuration for your OData connection.
- Date List- Provide an array of objects, where each object represents a record to be created. Each object in the array must contain the same structure, mapping the appropriate fields. Note: Maximum batch size is 1000 records per request
-
Add Field- Define which fields will be populated in each record.
- Click the empty field to the right of the dropdown to view a tooltip displaying all the available options for filling in the field.
- You can populate the field in one of the following options:
- Static value – number / string. when using strings, you need to surround them with single quotes (‘).
- Property value from a previous activity (Using the tooltip that opens when clicking on the field).
- Expression – using functions and/or Previous activity properties and/or static values (Using the tooltip that opens when clicking on the field).
- Repeat steps 1-3 for all the fields you want to populate.
Delete Record
This activity allows you to delete a specific record from an OData entity. It’s used for removing existing data (e.g., an old customer entry, a canceled order).- Object Type- Select the entity from which you want to delete a record. Only entities selected during the “Select Database Objects” step of your OData connection will appear here.
- User Name- Enter the value of the mandatory field used to identify the record to delete. In the example shown, user name is the identifier for the people entity.
Delete Records Batch
This activity enables you to delete multiple records from a specified OData entity in a single batch request, enhancing efficiency when removing a large number of entries.- Object Type- Select the entity from which you want to delete a record. Only entities selected during the “Select Database Objects” step of your OData connection will appear here.
- Data List- Provide an array of objects, where each object represents a record to delete. Maximum batch size is 1000 items per request.
- Icao Code- Enter the value of a mandatory field used to identify the record to be deleted. In the example shown, the Icao code is the primary identifier for the Airports entity.
Execute Action
This activity allows you to execute custom actions defined within your OData service. This is useful for triggering specific business logic or processes exposed by the OData service (e.g., “Reset Data Source”, “Share Trip”, “Update Last Name” as seen in the “Select Database Objects” image).- Action Type- This field selects the specific OData action to be executed. Its options are limited to the actions you previously chose in the “Select Database Objects” configuration for your OData connection.
- Person-User Name – A mandatory field needed to execute the action.
- Last Name – A mandatory field needed to execute the action. Note: Mandatory fields can vary depending on the action being performed. In this case, the action is “Update Last Name “, and these two fields are required to complete it.
- Add Field - Click Add Field to add and populate additional fields for the selected activity. To learn more about managing activity data, click here.
Get Record
This activity retrieves a single record from a specified OData entity based on its unique identifier. It’s used for fetching specific data when you know the exact record you need.- Object Type– Select the target entity from which a single record will be retrieved. Its options are limited to the entities you previously chose in the “Select Database Objects” configuration for your OData connection.
- Icao Code– Provide the required value to identify the record to retrieve. In this example, the Icao Code is the mandatory field for the Airports entity.
- Output Fields- Select one or multiple fields to include in the output. These are the fields whose values will be available in downstream steps. You can choose only the fields relevant to your use case to optimize performance and clarity.
Get Records
This activity retrieves multiple records from a specified OData entity, supporting advanced queries like filtering, sorting, limiting results, and pagination for precise data retrieval.- Object Type – This field selects the target entity from which multiple records will be retrieved. Its options are limited to the entities you previously chose in the “Select Database Objects” configuration for your OData connection.
- Output Fields - Select one or multiple fields to include in the output. These are the fields whose values will be available in downstream steps. You can choose only the fields relevant to your use case to optimize performance and clarity.
- Add Filter - Click Add Filter to define conditions that narrow down the data list and return only the relevant items. To learn more about using filters, click here.
- Add Sort - Click Add Sort to organize the data list by a selected field in ascending or descending order. To learn more about sorting data, click here.
- Top N - You can specify how many records with the same value you want to get. Click on ‘Top N’ and enter the maximum number of values you want to retrieve. For example – If you set
Top N = 1, a single record will be returned instead of an array. If no record is found, the action will fail, allowing you to implement an IF condition within the workflow. This can be useful for processes where the existence of a record determines the next steps in the workflow. - Offset - This field specifies the number of records to skip from the beginning of the result set before retrieving the rest. It is commonly used for pagination in conjunction with Top N. For example -If you set Offset = 2 and Top N = 3, three records will be returned starting from the second record will be returned. If no record is found, the action will fail, allowing you to implement an IF condition within the workflow. This can be useful for processes where the existence of a record determines the next steps in the workflow.
Get Records Batch
This activity allows you to retrieve multiple specific records from an OData entity in a single batch request. Unlike “Get Records” which queries based on filters, this action fetches records based on a provided list of unique identifiers, making it efficient for retrieving known sets of records in bulk.- Object Type– This field selects the target entity from which records will be retrieved in batch. Its options are limited to the entities you previously chose in the “Select Database Objects” configuration for your OData connection.
- Data List- This field accepts an array of objects, where each object typically contains the unique identifier of a record to be retrieved.
- Icao Code- Specify the icao code field that Engini should use to match and retrieve each record in the batch. In this example, Icao Code is the mandatory field of the Airports entity.
Initialize Object Array
This activity initializes a new, empty object array and assigns it to a specified variable. It’s typically used at the beginning of a process where you intend to collect multiple objects (e.g., OData records) into a single array for later processing, such as batch operations or data manipulation.- Variable name – This field defines the name of the new variable that will store the object array.
- Object Item Type – This field specifies the expected structure or schema of the individual objects that will be stored within the array. Select the type of object that this variable will contain. This determines the structure and available fields for each item in the list.
- Add Field - Click Add Field to add and populate additional fields for the selected activity. To learn more about managing activity data, click here.
Append to Object Array
This action adds a new object to an existing object array variable that was initialized earlier in the workflow.- Variable – Select the array you initialized in the previous steps. After selecting the variable, the “Add Field” option becomes available.
- Add Field - Click Add Field to add and populate additional fields for the selected activity. To learn more about managing activity data, click here.
Map Object Array
This action transforms a list of objects (an array) from one structure to another. It’s especially useful when you retrieve data from OData in one format and need to convert it to a different structure for use in subsequent actions or to send to another system.- Data List – This field specifies the input array of objects that you wish to transform.
- Object name – Select the type of object that each item in the list represents. This defines the structure and available fields for each item during the mapping process.
- Add Field - Click Add Field to add and populate additional fields for the selected activity. To learn more about managing activity data, click here.
Update Record
This action modifies an existing record within a specified OData entity. It’s used for changing specific fields of an existing data entry (e.g., updating a customer’s address, changing an order status).- Object Type– This field selects the target entity where an existing record will be updated. Its options are limited to the entities you previously chose in the “Select Database Objects” configuration for your OData connection.
- Primary Key Field (e.g., Icao Code)- Enter the value of the primary key that uniquely identifies the record update. In this example, Icao code is the mandatory field for the Airports entity.
- Add Field - Click Add Field to add and populate additional fields for the selected activity. To learn more about managing activity data, click here.
Update Records Batch
This action allows you to modify multiple existing records within a specified OData entity in a single batch request. This is highly efficient for performing bulk updates to your data.- Object Type- This field selects the target entity where all records in the batch will be updated. Its options are limited to the entities you previously chose in the “Select Database Objects” configuration for your OData connection.
- Data List-This field accepts an array of objects, where each object represents a record to be updated. Each object must include the unique identifier (key) of the record to be updated, along with the properties and their new values.
- Mandatory Field (e.g., Icao Code): Enter the value of the primary field that uniquely identifies the record update. In this example, Icao code is the mandatory for the Airports entity.
- Add Field - Click Add Field to add and populate additional fields for the selected activity. To learn more about managing activity data, click here.