Skip to main content

Activity 1: API Tools for an AI Agent

Your fictional company, Retentix, wants to improve its customer success process by empowering teams to proactively address churn risks using real-time data. Your task is to create an intelligent agent that allows employees to query customer health metrics, detect early warning signs, and trigger personalized outreach before a customer disengages. This activity provides instructions for two tools you can connect to your agent to surface churn signals, analyze behavior trends, and send retention alerts to account managers.

To get the Retentix Intelligent Churn Detection Agent ready to be helpful, you will create multiple AI Agent Tools that support a proactive customer experience strategy. First, you will create the Customer 360 API Tool, which aggregates and exposes unified customer data across systems to provide a complete, trusted view. Next, you will build the Customer Retention Metadata API Tool, designed to surface and expose key behavioral and sentiment indicators—such as engagement scores and unresolved cases—that help the AI agent identify at-risk customers. Finally, you will develop the Notification and Escalations Integration Tool, which enables downstream actions like automated alerts, ticket creation, and escalation workflows across systems such as Slack, ServiceNow, or email.

In this activity, you will complete the following:

  • Building the Customer 360 API Tool
  • Building the Customer Retention Metadata API Tool
  • Building the Notification and Escalations Integration Tool

Building the Customer 360 API Tool

  1. Select the AI button in the top right.

    AI button

    note

    This will open in a new window.

  2. If this is your first time accessing Agentstudio, it will look like this:

    First time accessing Agentstudio

  3. Select Get Started.

  4. Accept the Terms and Conditions.

    note

    Make sure to use the same account throughout your work for Integration and Agentstudio.

  5. Select Agent Designer from the left navigation.

    Agent Designer navigation

  6. Select the Tools tab.

Add Tool Type: API Tool

  1. Select Create New Tool.

  2. Select the API Tool.

  3. Select Add Tool.

    Add API Tool

  4. Enter the following:

    • Tool Name: [builderInitials] Customer 360
    • Description: Retrieve cleansed and validated customer information from the Golden Record.

    Customer 360 Tool Details

  5. Click + Add Input Parameter.

  6. Configure the contactId parameter:

    • Name: contactId
    • Description: Customer ID to retrieve.
    • Type: String
    • Required: False
  7. Click Add Input Parameter.

  8. Select Save & Continue.

Configure your API Tool

  1. Choose Add Manually on the Configuration screen.

    • Base URL: https://c04-usa-east.integrate.boomi.com
    • Method: GET
    • Endpoint Path: /ws/rest/tools/contact
    • Basic Authentication:
      • Username: boomi_joel_davenport-XBUHTV.MOKSAY
      • Password: 7880eeac-4e46-4a03-b7a3-fd421fd5e20b
      • Query Parameters:
        • contactId: {{contactId}}

    Customer 360 Configuration

  2. Select Save & Continue.

Deploy the Tool

  1. Select Deploy Tool.

    Deploy Tool screen

  2. Select Deploy.

    Deploy confirmation

success

Congratulations, you have successfully deployed your first AI Agentstudio Tool!

Building the Customer Retention Metadata API Tool

Add Tool Type: API Tool

  1. Select Create New Tool.

  2. Select the API Tool.

  3. Select Add Tool.

    Add API Tool

  4. Enter the following:

    • Tool Name: [builderInitials] Customer Retention Metadata
    • Description: Retrieve customer metadata from the data warehouse

    Customer Retention Metadata Tool Details

  5. Click + Add Input Parameter.

  6. Configure the customerId parameter:

    • Name: customerId
    • Description: Customer ID to retrieve for Metadata
    • Type: String
    • Required: False
  7. Click Add Input Parameter.

  8. Select Save & Continue.

Configure your API Tool

  1. Choose Add Manually on the Configuration screen.

    • Base URL: https://c04-usa-east.integrate.boomi.com
    • Method: GET
    • Endpoint Path: /ws/rest/tools/contactMetadata
    • Basic Authentication:
      • Username: boomi_joel_davenport-XBUHTV.MOKSAY
      • Password: 7880eeac-4e46-4a03-b7a3-fd421fd5e20b

    Customer Retention Metadata Configuration

  2. Select Save & Continue.

Deploy the Tool

  1. Select Deploy Tool.

    Deploy Tool screen

  2. Select Deploy.

    Deploy confirmation

success

Congratulations, you have successfully deployed your second AI Agentstudio Tool!

Building the Notification and Escalations Integration Tool

Add Tool Type: Integration

  1. Select Create New Tool.

  2. Select the Integration Tool.

  3. Select Add Tool.

    Add Integration Tool

  4. Enter the following:

    • Tool Name: [builderInitials] Notification and Escalation
    • Description: Notify and escalate high risk customers to be more proactive to churn risks and retention.

    Integration Tool Details

Add Input Parameters

  1. Select + Add Input Parameter.

  2. Enter the following:

    • Name: Name
    • Description: Name of the customer
    • Type: String
    • Required: Checked

    Add Input Parameter

  3. Select Add Input Parameter.

  4. Select Save & Continue.

Configure Integration Environment

  1. Enter the following:

    • Integration Environment: Prod-Cloud
    • Runtime: Workshop Worker
    • Process: [Intelligent Churn] (SHARED) Notification and Escalation

    Integration Tool Environment

  2. Select Save & Continue.

Add Dynamic Process Property

  1. Select + Add Dynamic Process Property.

  2. Enter the following:

    • Name: Name
    • Value: {{Name}}

    Dynamic Process Property

  3. Select Save & Continue.

Deploy the Tool

  1. Select Deploy Tool.

    Deploy Tool screen

  2. Select Deploy.

    Deploy confirmation

success

Congratulations, you have successfully deployed your third AI Agentstudio Tool and are ready to create your first AI Agent!