---
title: "Oracle Integration Cloud"
canonical: "https://help.agiloft.com/space/HELP/599261231/Oracle+Integration+Cloud"
format: markdown
---
With the Agiloft Adapter in the Oracle Integration Cloud (OIC), you can exchange data between Agiloft CLM and other applications using the [Oracle Integration 3](https://docs.oracle.com/en/cloud/paas/application-integration/) platform. The adapter uses OAuth 2.0 for access and the [REST API](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43715778) for data exchange.

This article explains how to create connections between your KB and OIC and helps familiarize you with the Agiloft Adapter. For details on OIC integrations, refer to Oracle’s [documentation](https://docs.oracle.com/en/cloud/paas/application-integration/integrations-user/get-started-integrations.html) on using integrations in Oracle Integration 3.

> ℹ️ **Prerequisites**
> ℹ️ 
> ℹ️ - You need a separate Agiloft CLM user account for each OIC connection you set up. For example, adding one trigger connection and one invoke connection requires two Agiloft CLM accounts. If connections share a user account, refreshing the access token for one connection invalidates tokens for the other connections. Ideally, the accounts are dedicated specifically for the OIC integration. Make sure they meet the following requirements:
> ℹ️   - Each user must be assigned an Admin license.
> ℹ️   - Each Agiloft user account needs a corresponding user account in OIC.
> ℹ️   - The email address in the Agiloft user record must match the email address in the OIC user record.
> ℹ️ - Make sure the Disable OAuth Content-Type Validation [global variable](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43713942) is set to Yes.
> ℹ️ - Make sure webhooks are deployed in your KB. To check, go to **Setup > Integration > Webhook Setup**. If you see a Configure button, webhooks are deployed. If you see a Deploy button, click it to deploy webhooks.

# Install the Agiloft Adapter

Before you can connect to Agiloft from OIC, you need to install the Agiloft Adapter on an Oracle integration instance. Follow the steps below to install the adapter.

1. Log in to your Oracle Cloud account and go to Application Integration.
2. If you already have an integration instance to use, go to the next step. If you need to create an instance, follow the instructions in Oracle’s [documentation](https://docs.oracle.com/en/cloud/paas/application-integration/oracle-integration-oci/creating-oracle-integration-instance.html#GUID-E37B7499-5CCE-4268-94EF-8EF4B0C5DAE5) to create one.
3. In the list of integration instances, click the name of the instance you want to use with Agiloft. The console displays the instance details.
4. Under Links, copy the Runtime URL and paste it into a note for later use.
5. Now, click Service console to go to the OIC console.
6. From the console, install the Agiloft Adapter on the instance:
  1. Click Browse Store.
  2. Search for Agiloft to find the adapter, then click Get.
  3. In the Get adapter dialog box, review and accept the Oracle and partner terms and conditions, then click Get. The adapter is installed.

Now that the adapter is installed, proceed to the next section to set up Agiloft.

# Create an OAuth Client in Agiloft

To connect your KB to OIC, set up an OAuth client API application for each connection you want to make. The steps below guide you through creating an OAuth client. For details on OAuth 2.0 clients in Agiloft CLM, see [Use OAuth2 to Access REST API](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43716464).

1. Log in to your KB.
2. First, check the value of the Disable OAuth Content-Type Validation global variable:
  1. Go to **Setup > System > Manage Global Variables**.
  2. Find Disable OAuth Content-Type Validation and check its value.
  3. If it’s set to Yes, go to step 3. If it’s set to No, change the value to Yes and save the change.
3. Now, make sure Webhooks are deployed:
  1. Go to **Setup > Integration** and find Webhooks Setup.
  2. If a Deploy button is shown, click it. If Configure is shown, go to the next step.
4. Next, navigate to **Setup > Integration > OAuth2 Client Setup**.
5. Click New to create an API Application.
6. For Authorization Grant Type, leave Authorization Code selected. Client Credentials grant is not supported with the API.
7. Next, give the application a Name and Display Name. For example, Oracle Trigger Connection or Oracle Invoke Connection. The Name and Display Name values can be the same.
8. In the Full Name field, select the Agiloft user account for this connection. Selecting an account populates the “Associate this Application with Contact ID” field with the record ID for the user.

> 📝 If you’re setting up more than one OAuth client connection, make sure you select a different user for each connection.

9. For the Redirect URI field, follow the steps below to create a URI that looks like this: `<integration_instance_runtime_URL>/icsapis/agent/oauth/callback`
  1. First, add the Runtime URL that you copied during the initial Oracle setup.
  2. Now, add the following text after oraclecloud.com/: `icsapis/agent/oauth/callback`
  3. The complete URI should look similar to this example: `https://example-ix7ekyefcddf-ia.integration.us-ashburn-1.ocp.oraclecloud.com/icsapis/agent/oauth/callback`
10. The Token Expiry in Minutes field is set to 15 minutes by default. You can adjust the value if needed. Valid values are 1 – 60.
11. Click Apply Changes to save the configuration.
12. Now click Enable to activate the connection. The system generates a Client ID and Client Secret to use for exchanging tokens with Oracle.

To create clients for additional connections, repeat the steps above. If you’re finished creating clients, leave Agiloft open in one tab and proceed to the next section to create connections in OIC.

# Create a Connection in OIC

Now that the Agiloft OAuth clients are set up, you can configure the connections in OIC. When completing the steps below, it helps to have the Agiloft user interface open so you can switch between Agiloft and the OIC console.

> 📝 To complete the configuration, you need the login credentials for the Agiloft user accounts you chose when setting up the OAuth clients.

1. Log in to your Oracle account and open the OIC console for your integration instance.
2. Go to Projects in the sidebar and select the project in which you want to configure the Agiloft integration. If you don’t have a project, follow Oracle’s [documentation](https://docs.oracle.com/en/cloud/paas/application-integration/integrations-user/create-or-import-project.html#GUID-86A34148-8A35-4B36-9020-8DC36D6DF976) to create one.
3. In the project, go to the Connections panel and click Add.
4. Find and select the Agiloft Adapter. The Create Connection dialog box is displayed.
5. In the Create Connection dialog box, set up the connection:
  1. Give the connection a name. The Identifier field is automatically populated based on the Name.
  2. In the Role field, select the role for the connection. Role refers to the function of the source and target applications when the integration runs: Trigger or Invoke.
    - With Trigger connections, the source application starts (or triggers) the integration. When it detects an event, it sends an integration message to the target, such as “A new record was created.” The adapter supports two types of triggers:
      - Create/Update record event
      - Delete record event
    - With Invoke connections, the target application receives the message and runs (or invokes) the configured actions, such as “Create a record in Application X.” The adapter supports the following invoke actions:
      - Create, Read, Update, Delete, and Search Record
      - Get, Upload, and Remove Attachment  
:info: See [Creating Integrations](#develop_integration) below for details on the trigger events and invoke actions.
  3. You can add optional Keywords for finding this connection as well as an optional Description.
  4. If you want to make this connection available in other projects, you can enable Share with other projects.
  5. Click Create to create the connection. The configuration screen is displayed.
6. Complete the fields under Properties:
  1. **KB Name**: The name of your KB, shown in the top right header of the Agiloft user interface.
  2. **KB Domain**: The base URL for your KB, shown in the browser URL. Do not include `https//`. For example: `example.agiloft.com`
  3. **Contact ID**: The "Associate this Application with Contact ID" value from the OAuth client configuration.
7. Complete the Security fields:
  1. **Client Id**: The Client ID value from the OAuth client configuration.
  2. **Client Secret**: The Client Secret value from the OAuth client configuration.
8. After entering the client ID and secret, click Provide Consent and follow the prompts to authenticate with Agiloft:
  1. Supply the login and password for the user who matches the Contact ID you entered above, then click OK.
  2. Click Allow Access to confirm access for the Oracle connection.
  3. A success message is displayed. You can close the tab.
9. Return to the OIC console and click Test to test the connection. When the test completes successfully, Configuration progress changes to 100%.
10. Click Save to save the configuration. This connection can now be used in integrations.

To create additional connections, repeat the steps above. If you’re finished creating connections, proceed to the next section to create an integration and learn about the Agiloft Adapter.

# > Macro (anchor)

Creating Integrations

Now that you have connections to Agiloft in OIC, you can set up integrations that define how to use the connections and share data between Agiloft and your applications. For instructions on developing integrations, refer to Oracle’s [documentation](https://docs.oracle.com/en/cloud/paas/application-integration/integrations-user/create-integrations.html) on creating integrations.

The sections below describe how to configure trigger and invoke endpoints with the Agiloft Adapter.

## Adding Trigger Endpoints

When you add an Agiloft trigger endpoint to an integration, you can choose to start the integration when records are created, updated, or deleted. This section describes the supported trigger events.

> 📝 Activating an integration with a trigger endpoint automatically generates a webhook for that integration in Agiloft. You must activate the webhook before running the integration. See [Activating a Webhook](#activate_webhook) below.

### Create/Update table record event

Use this type of event to trigger the integration when records are created or updated in Agiloft. When you create this trigger, configure the following settings:

- **Table**: The table to watch for new or updated records.
- **Event Type**: The types of events that should trigger the integration: when a record is created, when a record is updated, or both.
- **Fields**: The fields you want Agiloft to return in the response.
- **User**: The Agiloft login for a user with read access to the table. The webhook uses the permissions of this user to fetch and send data to Oracle. This can be a different user than the one used to create the trigger connection in OIC.

![Create Update table record event configuration in OIC](media://f733d178-0d04-4fc1-bdbb-51413c010992)

### Delete table record event

Use this type of event to trigger an integration when records are deleted in Agiloft. When you create this trigger, configure the following settings:

- **Table**: The table to watch for deleted records.
- **User**: The Agiloft user login with read access to the table. The webhook uses the permissions of this user to fetch and send data to Oracle. This can be a different user than the one used to create the trigger connection in OIC.

### > Macro (anchor)

Activating a Webhook

When you activate an integration that includes a trigger endpoint, OIC calls the Agiloft REST API to register a webhook for that integration. You must activate the webhook in Agiloft before running the integration in OIC. Follow the steps below to activate a webhook by adding authorization to the HTTP header.

1. In Agiloft, go to **Setup > Integration > Webhook Setup**. The screen lists the registered webhooks. Webhooks from OIC are prefixed with Oracle Integration. Disabled webhooks have a Status of Inactive.
2. Click the Edit icon for the webhook you want to activate.
3. On the Webhook Configuration screen, find the Webhook Http Headers field.
4. Follow the steps below to create an HTTP header string that looks like this: `Authorization: Basic <base64-encoded_OIC_username:password>`
  1. In a note, enter the following text: `Authorization: Basic username:password`  
Be sure to include the colon between username and password.
  2. Now replace username and password with your OIC login credentials or the credentials for another OIC account. The user you choose doesn’t have to match the Full Name and User ID in the existing webhook configuration. Those values represent the Agiloft user from the trigger configuration.
  3. Next, copy the updated username:password portion of the string (including the colon). Paste it into an approved Base64 encoding tool and encode the value. The result looks similar to: ZXJlfi7tYZJ1aW7AZWdbaG0ltD5jb216QzF0cEBuc24uNMWh
  4. In your note, replace username:password with the encoded value.
  5. Now copy and paste the entire string into the Webhook Http Headers field. The final string looks similar to: `Authorization: Basic ZXJlfi7tYZJ1aW7AZWdbaG0ltD5jb216QzF0cEBuc24uNMWh`
5. At the bottom of the screen, click Apply Changes.
6. Now click Enable to activate the webhook. The Status of the configuration changes to Active. You can close the record.

Now that the webhook is active, the integration can run. To activate additional webhooks, repeat the steps above.

## Adding Invoke Endpoints

When you add an invoke endpoint to an integration, you can configure actions that create, read, update, delete, and search records as well as get, update, or remove attachments. This section describes the supported invoke actions.

### Create Record

Use a Create Record action to create a record in Agiloft. When you create this action, you only need to select the target table to create the record in. Adding the action to an integration automatically adds a map component. The mapping includes all of the columns in the selected target table. Map a source column to each of the target columns you want to populate in the new record.

### Read Record

Use a Read Record action to retrieve a record from Agiloft by record ID. When you create a Read Record action, you only need to select the table that stores the record. Adding the action to an integration automatically adds a map component. In the mapping, you're required to supply the ID of the record to read. 

For example, the mapping below uses an Assign action as input. The action defines a ContractID variable with a numeric value that matches a Contract record ID. ContractID is then mapped to Id.

![Mapping with input to the Id node](media://040982e0-3302-4a09-b464-7a9ff2f58f71)

Running the action returns all of the fields for the specified record. For example:

```xml
<ReadRecordActionResponse xmlns="http://xmlns.oracle.com/cloud/adapter/4133917220439:agiloftoic/readcontract/types">
  <ResponseWrapper>
    <terminate_early>False</terminate_early>
    <type xmlns="">contract</type>
    <set_contract_end_date_using>Contract term</set_contract_end_date_using>
    <show_end_date>Yes</show_end_date>
    <related_to_for_conversion>Contracts</related_to_for_conversion>
    <contract_type_task_generation_method>User Generated Ad Hoc Tasks</contract_type_task_generation_method>
    <update_ds_files_to_send_flag>No</update_ds_files_to_send_flag>
    <recipients>No filter</recipients>
    <contract_owner_email>example4@example.com</contract_owner_email>
    <contract_title1>Other - DataLoom Systems - Aug 30 2025</contract_title1>
    <latest_screen_run_id>447</latest_screen_run_id>
    <create_new_company>False</create_new_company>
    <creator_team>Contract Management Team</creator_team>
    ...
      </ResponseWrapper>
</ReadRecordActionResponse>
```

### Update Record

Use an Update Record action to update a record in Agiloft. When you create this action, you only need to select the table to update the record in. Adding the action to an integration automatically adds a map component. The mapping includes all of the columns in the selected target table. Map a source column to each of the target columns you want to update.

### Delete Record

Use a Delete Record action to delete a record in Agiloft. When you create this action, you only need to select the table to delete the record from. Adding this action to an integration automatically adds a map component. In the mapping, you’re required to supply the ID of the record to delete.

For example, an Assign action is used as input to the mapping below. The action defines a ContractID variable with a numeric value that matches a Contract record ID. ContractID is then mapped to Id.

![Mapping with input to the Id node](media://372a1d28-7b98-487d-a8c9-641a92de3677)

### Search Record

Use a Search Record action to find records in your KB using an Agiloft search query. When you create this action, you configure the following settings:

- **Table**: The table to search.
- **Fields**: The fields to return in the response.

Adding the action to an integration automatically adds a map component. The only required input in the map is the Query node, for which you can define a search expression. For example, an Assign action is used as input to the mapping below. The action defines a records variable with a numeric value. Adding the Query expression `concat(“id>=”, records)` in the mapping finds records where the record ID is greater than or equal to the variable value. 

![Mapping showing a Query expression](media://2ccebb21-39f8-4429-b56b-c632e82ebc24)

Running the action returns the selected fields for the records that meet the search criteria. For example:

```xml
<SearchRecordActionResponse xmlns="http://xmlns.oracle.com/cloud/adapter/4133917220439:agiloftoic/SearchRecord/types">
  <ResponseWrapper>
    <topLevelArray>
      <contract_title1>Services Agreement - StrataGlobe Financial - Jan 05 2025</contract_title1>
      <date_created>Jun 05 2025 17:27:44</date_created>
      <contract_start_date>Jul 01 2025</contract_start_date>
      <contract_description />
      <id>900</id>
      <company_name>StrataGlobe Financial</company_name>
      <contract_amount />
      <date_updated>Sep 29 2025 09:16:58</date_updated>
    </topLevelArray>
    <topLevelArray>
      <contract_title1>Non-Disclosure Agreement - EvoDyn Microsystems - Dec 15 2025</contract_title1>
      <date_created>May 15 2026 18:21:12</date_created>
      <contract_start_date>May 20 2026</contract_start_date>
      <contract_description />
      <id>904</id>
      <company_name>EvoDyn Microsystems</company_name>
      <contract_amount />
      <date_updated>Sep 29 2025 09:16:54</date_updated>
    </topLevelArray>
    ...
  </ResponseWrapper>
</SearchRecordActionResponse>
```

### Get Attachment

Use a Get Attachment action to retrieve an attachment from Agiloft in binary form. When you create a Get Attachment action, you configure the following settings:

- **Table**: The table to find the attachment in, such as Attachment.
- **Field with attachments**: The field that stores the attachments, such Attached File.

Adding this action to an integration automatically adds a map component. In the mapping, you’re required to supply the ID of the record to get the attachment from. If the attachment field contains multiple files, you can also supply the File Position for the attachment you want to retrieve. In Agiloft, the default file position is 0.

For example, an Assign action is used as input to the mapping below. The action defines an AttachmentID variable with a numeric value that matches an Attachment record ID. AttachmentID is then mapped to Record Id.

![Mapping with input to the Record Id node](media://cca90419-e1f5-4b03-bbbf-dd74af9939b4)

Running the action returns the binary in a Content object. For example:

```xml
<GetAttachmentActionResponse xmlns="http://xmlns.oracle.com/cloud/adapter/4133917220439:agiloftoic/GetAttachment/types">
  <ResponseWrapper>
    <file_name>SC007+-+VectorGate+Customer+NDA--SIGNED+COPY.pdf</file_name>
    <content_length>104262</content_length>
    <content>
      <streamReference>fss:/ocid1_integrationinstance_oc1_iad_amaaaaaa3lefxjaayw6i2d2uw6vf5eakcccz6jcclgca7oaailbxihdrbvlq/INfUeaBiEfCkPwEDIO82qw/47fe6c54-35ad-435a-a4d3-b34345e076ef@_@WSbxnzuJH+8PcvUXGmDVA/DgKzq5z...</streamReference>
    </content>
  </ResponseWrapper>
</GetAttachmentActionResponse>
```

### Upload Attachment

Use an Upload Attachment action to upload binary content to Agiloft. When you create this action, you configure the following settings:

- **Table**: The table to add the attachment to, such as Attachment.
- **Field with attachments**: The field to store the attachment in, such Attached File.

Adding this action to an integration automatically adds a map component. You’re required to map the record ID to upload the attachment to, the Content Type of the file, and the Content, which holds the binary content. You can also supply the File Name.

For example, the following mapping uses a Get Attachment response as input as well as Assign actions to supply the record ID and content type.

![Mapping for an Upload Attachment action](media://246f76dd-7610-4f0e-91fe-6d3596ae3b79)

### Remove Attachment

Use a Remove Attachment action to delete a file from Agiloft. When you create this action, you configure the following settings:

- **Table**: The table that includes the attachment, such as Attachment.
- **Field with attachments**: The field that stores the attachment to delete, such Attached File.

Adding this action to an integration automatically adds a map component. In the mapping, you’re required to supply the ID of the record that contains the attachment to delete. If the attachment field contains multiple files, you can also supply the File Position for the attachment you want to remove.