> For the complete documentation index, see [llms.txt](https://doc.aissist.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.aissist.io/tutorial/add-actions.md).

# Add Actions

Connect your systems to Aissist with a connector, add actions on it - order lookup, tracking, cancellation, your own API - and test them with the action debugger.

*Last updated: November 12, 2026*

Actions let your agent read live data and get things done in your systems, such as looking up an order, tracking a parcel or cancelling an order. This page shows how to add actions on a connector and test them.

For what actions and connectors are, see [Actions](https://doc.aissist.io/capabilities/actions.md) and [Connectors](https://doc.aissist.io/capabilities/connectors.md).

### How it fits together

* A **connector** is the connection to one of your systems: its address and credentials. It belongs to the project and is shared by every workspace in it.
* An **action** is one thing the agent can do through a connector, such as `getOrder`. It belongs to a workspace and is usually linked to the sub-agents that need it.

### Create a connector

An action runs on a connector, so connect the system first: see [Add Connectors](https://doc.aissist.io/tutorial/add-connectors.md) and the page for your system, such as [Shopify](https://doc.aissist.io/tutorial/add-connectors/ecommerce/shopify.md), [WooCommerce](https://doc.aissist.io/tutorial/add-connectors/ecommerce/woocommerce.md), a [database](https://doc.aissist.io/tutorial/add-connectors/databases.md) or [any REST API](https://doc.aissist.io/tutorial/add-connectors/rest-api.md).

### Add an action

{% stepper %}
{% step %}

### Describe the action

Go to **Workspace → Actions** and click **Add Action**. Under **What should this action do?**, write in your own words what it does, when it should run, what it needs from the customer, and what to tell the customer with the result. For example:

> Look up an order's shipping status by order number when a customer asks where their parcel is. Tell them the carrier, the tracking link and the expected delivery date.

Click **Continue**.
{% endstep %}

{% step %}

### Choose the connector

Aissist scans your connectors. When more than one could carry the action, it asks you to choose.
{% endstep %}

{% step %}

### Review the draft

The draft uses a predefined action when one fits, and builds a custom one when none does. Review:

* **Name** and **Trigger scenario**: when the agent should run it.
* **Method** and **Parameters**: what it calls and what it needs from the conversation.
* **What to tell the customer with the result** and **How to use what it returns**.
* **Run at start** (once, when a conversation starts) and **Run at interaction** (whenever its scenario comes up).
* The sub-agents that should use it. Suggested ones are marked; untick any you do not want.

Nothing is created until you click **Create action**.
{% endstep %}
{% endstepper %}

The **Actions** list shows each action's connector, its kind, and whether it runs at start or at interaction. The kinds are:

* **Linked**: a predefined action used as it is.
* **Instanced**: a predefined action with your own name, scenario, response handling and parameter descriptions.
* **Customized**: your own request, such as a call to your own API.

<details>

<summary>Build an action in the classic editor</summary>

On **Add Action**, click **Or build it yourself in the classic editor**.

**Configuration**

* **Connector** and **Method (required)**: the connector and what to call on it.
* **Name (required)**: a clear name, such as `getOrderStatus`.
* **Action Trigger (required)**: **Inbound** (detected and run on the customer's message) or **Outbound** (on the agent's reply).
* **Execute at session start** and **Execute at interaction**, and **Run after** to run it after another action.
* **Trigger Scenario (required)**: the scenario this action handles, in plain words.

**Parameters**

* **Execution Properties**: fixed values sent every time, such as a store code.
* **Request Parameters**: values extracted from the conversation, each with a name and a description.

Parameter descriptions tell the agent how to fill each value. Be specific about formats and rules, for example:

> order\_id: order IDs start with an `E` followed by 8 digits

> order\_in\_last\_n\_days: retrieve orders from the last 180 days

**Post Processing**

* **Summarization**: what to extract from a long response, such as "extract the user email, total price and delivery status".
* **Instruction**: how to interpret or use the result.

</details>

### Test with the action debugger

The action debugger runs your actions on a test message and shows exactly what was called and returned.

1. Go to **Workspace → Actions** and click **Debug**.
2. Under **Available Actions**, select the actions to test.
3. Type a message that should trigger one, such as "where is my order #1234?", and click **Test Actions**.
4. Read the **Results**: which action ran, the parameters sent, and the response. **History** keeps the messages of the test so you can test follow-ups. **Clear** starts over.

Once the action works here, test the whole conversation in [Try](https://doc.aissist.io/tutorial/try.md).

<details>

<summary>Fix common issues</summary>

**The action does not run**

* Make the **Trigger Scenario** describe the situation clearly.
* Check the action is linked to the right sub-agent, and set to run at start or at interaction.
* Check the test message matches the scenario.
* Check the connector's **Status** and click **Test** on its page.

**The parameters are wrong**

* Improve the parameter names and descriptions.
* Add exact formats, examples or allowed values.

**The response is hard to use**

* Add a **Summarization** that keeps only what the agent needs.
* Add an **Instruction** on how to present the result.

</details>

### Vendor notes

The steps on the vendor's side - creating the credentials - are below. On the Aissist side, every vendor follows [Create a connector](#create-a-connector).

<details>

<summary>Shopify</summary>

**In Aissist:** enter your **Store** (the first part of your address, such as `acme` for `acme.myshopify.com`), then choose one authentication method:

* **App client ID and secret**: the **Client ID** and **Client secret** of an app from the Shopify Dev Dashboard, installed on this store.
* **Admin API access token (legacy custom app)**: the token of an existing custom app, starting with `shpat_`.
* **Sign in with Shopify**: sign in to the store in a pop-up.

**In Shopify:** new apps are created in the [Shopify Dev Dashboard](https://shopify.dev/docs/apps/build/dev-dashboard): create the app, grant the scopes below, install it on your store, and copy its client ID and secret. For an existing custom app made in the Shopify admin, its access token works too:

1. In your Shopify admin, go to **Settings → Apps and sales channels → Develop apps**, and allow custom app development if asked.
2. Click **Create an app** and name it.
3. Under **API credentials**, click **Configure Admin API scopes** and grant: `read_shipping`, `read_fulfillments`, `read_merchant_managed_fulfillments`, `read_customers`, `read_inventory`, `read_orders`, `read_returns`, `read_products`, `read_product_listings` and `write_orders`.
4. Click **Install app** and copy the **Admin API access token**.

<figure><img src="https://301624521-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyKHM836KGDAfAWvw6XL6%2Fuploads%2F8p1DrODoyrgtdsQSzErr%2FScreenshot%202024-09-17%20at%2011.17.32%20PM.png?alt=media&amp;token=883f9a30-604f-4cff-b2f9-56e9b20eda27" alt=""><figcaption></figcaption></figure>

See [Shopify's guide](https://shopify.dev/docs/apps/auth/admin-app-access-tokens) for details.

{% hint style="info" %}
On the Shopify Basic plan, Shopify restricts access to some personal customer data, such as name, address, phone number and email.
{% endhint %}

**Predefined actions:** `getOrder`, `getCustomer`, `getCustomerOrders`, `sendOrderInvoice`, `cancelOrder`, `updateOrderAddress`, `addOrderTag`, `unsubscribeMarketingEmail`, `getProducts` and `getProductById`.

</details>

<details>

<summary>WooCommerce</summary>

**In WooCommerce:**

1. In your WordPress admin, go to **WooCommerce → Settings → Advanced → REST API**.
2. Click **Add key**. Read permission is enough for lookups.
3. Save the **Consumer key** and **Consumer secret**. WooCommerce may not show them again.

<figure><img src="https://301624521-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyKHM836KGDAfAWvw6XL6%2Fuploads%2F5ZwKichKzs7n1RjbNrHw%2Fwoocommerce_key.png?alt=media&amp;token=9f70dd9b-096d-4083-a71a-249eed8ceaef" alt=""><figcaption><p>Create Consumer Key and Consumer Secret</p></figcaption></figure>

**In Aissist:** enter the **Store URL** (your WordPress site's address, over https, such as `https://shop.example.com`), the **Consumer key** (`ck_...`) and the **Consumer secret** (`cs_...`).

**Predefined actions:** `getOrder`, `getCustomer`, `getCustomerOrders`, `getCustomerSubscriptions`, `cancelOrder` and `updateOrderAddress`.

</details>

<details>

<summary>Adobe Commerce (Magento 2)</summary>

**In Adobe Commerce:**

1. Create an integration under **System → Integrations** and get its access token. See Adobe's guide to [integration tokens](https://developer.adobe.com/commerce/webapi/get-started/authentication/gs-authentication-token/#integration-tokens).
2. Allow at least: **Read Store**, **Read Customer**, **Read Invoices**, **Read Orders**, **Read Returns**, **Read Shipments**, **Read Credit Memos** and **Write Orders**. Optionally **Read Integration**, **Read Inventory** and **Read Product**.
3. Under **Stores → Configuration → Services → OAuth → Consumer Settings**, enable **Allow OAuth Access Tokens to be used as standalone Bearer tokens**.

**In Aissist:** choose **Adobe Commerce (Magento)** and enter the **Store URL**, the **Store code** (`default` unless you run several store views) and the **Integration access token**.

**Predefined actions:** `getOrder`, `getCustomer`, `getCustomerOrders`, `getInvoice`, `resetPassword`, `cancelOrder` and `updateOrderAddress`.

</details>

<details>

<summary>ShipStation</summary>

**In ShipStation:**

1. Go to **Settings → API Settings**.
2. Select the **V2 API** (v1 keys do not work) and click **Generate API Key**.
3. Copy the key and store it safely. You may not be able to view it again.

See [ShipStation's API key docs](https://docs.shipstation.com/authentication).

**In Aissist:** enter the **API key**.

**Predefined action:** `trackOrder`, which tracks a shipment by order ID and returns the tracking number, tracking link, status, carrier details, ship and delivery dates and event history.

Example parameter description: "Order ID from Shopify, format `SHOPIFY-123456789`".

</details>

<details>

<summary>ParcelPanel</summary>

ParcelPanel is now CWILL Tracking.

**In ParcelPanel:** log in, open **Integration** (the label may vary by account type), and copy the **API Key**. Keep it private.

**In Aissist:** choose **ParcelPanel (CWILL Tracking)**, keep the default **API host** unless told otherwise, and enter the **API key**.

**Predefined action:** `trackOrder`, which tracks a shipment by order number and adds warnings for stale shipments and long shipping times. Its parameters:

* `order_number`: the order number, such as a Shopify order number.
* `stale_days_threshold`: days without a tracking update before a stale-shipment warning, such as `7`.
* `max_shipping_days`: shipping days before a long-shipping warning, such as `21`.

Example instruction for the result: "Summarize the tracking status and highlight any warnings. Include the current location, expected delivery date and carrier. If there are warnings, explain them and suggest next steps."

</details>

<details>

<summary>REST API</summary>

Use the REST API connector for any HTTP API, such as your own order, booking or account system.

**In Aissist:** enter the **Base URL** (every request's path is added to it), choose the **Authentication** - **No authentication**, **API key**, **Bearer token**, **Username and password**, **OAuth 2.0 client credentials** or **OAuth 2.0 (sign in)** - and add any **Headers** your API needs. Mark a header secret to store its value encrypted. Optionally set a **Connection test** path, such as `/health`.

Then add actions with a custom request: the method, the endpoint path and the parameters. Common patterns:

* **Order tracking**: shipping status from a logistics API.
* **Booking lookup**: appointment details from a booking system.
* **Inventory check**: stock levels from a warehouse system.
* **Refund status**: refund details from a payment platform.

If the response is large, add a **Summarization** so the agent keeps only what it needs.

</details>

<details>

<summary>AWS Lambda</summary>

Use AWS Lambda to reach internal systems through a small function you control, instead of exposing a database or backend. The function decides exactly what data comes back.

**In AWS:**

1. Write a function that does one job and returns only the fields the agent needs. For example, a booking lookup:

```python
import json

def lambda_handler(event, context):
    booking_id = event.get("booking_id")
    booking = find_booking(booking_id)  # your own lookup
    return {"booking": booking}
```

2. Create the function in the **AWS Lambda Console** and deploy it.
3. Create an IAM user (or role) allowed `lambda:InvokeFunction` and `lambda:GetFunctionConfiguration` on this function only, and create an access key for it.

<figure><img src="https://301624521-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyKHM836KGDAfAWvw6XL6%2Fuploads%2FCMAM1EIOPnGymgA5ITqG%2Flambda_setup.png?alt=media&amp;token=7b121cd5-094b-4040-beb8-7f7ffba8936d" alt=""><figcaption></figcaption></figure>

**In Aissist:** choose **AWS Lambda** and enter the **Region** (such as `us-east-1`), the **Function name or ARN**, and the **Access key ID** and **Secret access key**. Optionally add a **Role to assume** and its **External ID**.

Alternatively, publish the function with a Function URL or API Gateway and connect that URL with the REST API connector.

</details>

<details>

<summary>Help desks</summary>

A help desk connector (Zendesk, Intercom or Freshdesk) can carry an action that creates a ticket, for example: "Create a Zendesk ticket of type Refund, with the order number, when a customer asks for a refund." Describe it on **Add Action**, then check the ticket type and how each field is filled on the action's **Ticket** tab.

</details>

### Do it with Ask Engine

**Add Action** is Ask Engine: describe the action, and Ask Engine finds the connector that can carry it, picks a predefined action or writes a custom one, and suggests the sub-agents that should use it. You review the draft before anything is created.

> Cancel an order that has not shipped yet, after the customer confirms the order number

In **Ask**, you can also check what an action really returns. Actions that only read data run on request; Ask Engine refuses to run an action that could change something in your systems.

> Call the order lookup action for order 1234 and show me what it returns

See [Ask Engine](https://doc.aissist.io/capabilities/ask.md).

### Best practice

* Use a predefined action when one fits; build a custom one only for logic it does not cover.
* Give each action one clear job, a clear trigger scenario, and specific parameter descriptions.
* Link actions to the sub-agents that need them rather than running everything everywhere.
* Prefer read-only credentials for lookups, and allow write access only for the actions that need it.
* Test every action in the debugger with several realistic inputs, then in **Try**.

### Related

* [Actions](https://doc.aissist.io/capabilities/actions.md)
* [Connectors](https://doc.aissist.io/capabilities/connectors.md)
* [Add Sub Agents](https://doc.aissist.io/tutorial/add-sub-agents.md)
