Skip to main content
Built-in operations an agent can run as App Action steps. Each action has typed inputs and outputs. Cart and checkout operations live in Storefront actions.

​
Customers

Create a new customer.Input
​
email
string
required
Customer email address
​
full_name
string
required
Customer full name
Output
​
customer
CustomerOutput | null
Retrieve customer by ID, UUID, or email.Input
​
customer_id
integer | null
Customer ID
​
customer_uid
string | null
Customer UUID
​
email
string | null
Customer email
Output
​
customer
CustomerOutput | null
Update customer details.Input
​
customer_id
integer
required
Customer ID to update
​
email
string | null
New email address
​
full_name
string | null
New full name
Output
​
customer
CustomerOutput | null
​
changed_fields
string[]

​
Email

Sends an email to a recipient.Input
​
to
string
required
​
subject
string
required
minLen: 1, maxLen: 998.
​
html
string
Default: "".
​
content
string
Default: "".
​
from
string | null
Output
​
to
string
​
subject
string

​
HTTP

Sends an HTTP request to any URL.Input
​
url
string
required
minLen: 1, maxLen: 2083.
​
method
enum (`GET`, `POST`, `PUT`, `PATCH`, `DELETE`)
required
​
headers
object
​
body
object
​
timeout
integer
min: 1, max: 300. Default: 30.
Output
​
status_code
integer
min: 0.
​
response
object | string | null
​
headers
object

​
Inventory

Check current inventory level for a product and determine if stock is low.Input
​
product_id
integer
required
min: > 0.
​
threshold
integer
min: 0. Default: 10.
Output
​
product_id
integer | null
​
product_name
string | null
​
inventory_count
integer | null
​
is_low_stock
boolean | null
​
threshold
integer | null

​
Invoices

Create a new invoice with line items.Input
​
customer_id
integer | null
​
currency
string | null
​
bill_to_name
string | null
​
bill_to_email
string | null
​
line_items
CreateInvoiceLineItemInput[]
required
Output
​
invoice_id
integer | null
​
invoice_uid
string | null
​
status
string | null
​
total
integer | null
Append a line item to an existing invoice.Input
​
invoice_uid
string
required
​
title
string
required
​
quantity
integer
required
min: 1.
​
unit_price
integer
required
min: 0.
​
product_id
integer | null
​
description
string | null
Output
​
line_item_id
integer | null
​
invoice_id
integer | null
Retrieve invoice details by UID.Input
​
invoice_uid
string
required
Output
​
invoice_id
integer | null
​
invoice_uid
string | null
​
invoice_number
string | null
​
status
string | null
​
source
string | null
​
customer_id
integer | null
​
order_id
integer | null
​
currency
string | null
​
subtotal
integer | null
​
discount
integer | null
​
tax
integer | null
​
total
integer | null
​
bill_to_name
string | null
​
bill_to_email
string | null
​
line_items
InvoiceLineItemOutput[]

​
Notification

Fetch a workspace’s notifications with optional filters. Useful upstream of an AI reasoning step (digest, escalation) or before an action that depends on what’s pending. Output is a list summary with count + rows.Input
​
categories
string[] | null
Filter. One of: approval, integration, agent, billing, auth, system.
​
severities
string[] | null
Filter. One of: info, suggestion, warning, action_required, celebration.
​
include_read
boolean
Default: true.
​
include_dismissed
boolean
Default: false.
​
include_acted
boolean
Set to false to find only pending action items. Default: true.
​
since_hours
integer | null
Only rows created in the last N hours.
​
limit
integer
Capped at 200. Default: 50.
Output
​
count
integer
​
notifications
object[]
Send a workspace-scoped notification. Stores only type + payload; title, body, deep link, and quick actions render at view time per type.Input
​
notification_type
string
required
Notification type slug. One of: workflow_approval_required, integration_auth_failed, agent_insight_ready, system_announcement.
​
payload
object
required
Type-specific payload, validated against the schema for notification_type.
​
severity
string
required
One of: info, suggestion, warning, action_required, celebration.
​
category
string
required
One of: approval, integration, agent, billing, auth, system.
​
idempotency_key
string | null
Optional dedupe key; matching non-deleted rows are returned instead of creating a new one.
Output
​
notification_uid
string | null

​
Orders

Retrieve order details by ID.Input
​
order_id
integer
required
min: > 0.
Output
​
order_id
integer | null
​
order_uid
string | null
​
status
string | null
​
customer_id
integer | null
​
customer_email
string | null
​
subtotal_amount
number | null
​
total_amount
number | null
​
tax
number | null
​
line_items
OrderLineItemOutput[]
Retrieve orders for a specific customer.Input
​
customer_id
integer
required
min: > 0.
​
limit
integer
min: 1, max: 100. Default: 50.
Output
​
customer_id
integer | null
​
orders
CustomerOrderOutput[]
​
count
integer
Get the total number of orders placed by a specific customer.Input
​
customer_id
integer
required
min: > 0.
Output
​
customer_id
integer | null
​
order_count
integer | null
Update an order’s billing address.Input
​
order_uid
string
required
​
line1
string
required
​
city
string
required
​
postal_code
string
required
​
country
string
required
​
line2
string | null
​
state
string | null
Output
​
order_id
integer | null
Update order fields in a secure workspace-scoped manner.Input
​
order_id
integer
required
min: > 0.
​
updates
object
required
Fields to update on the order
Output
​
message
string | null
Update order integration metadata.Input
​
order_id
integer
required
min: > 0.
​
metadata
object
required
Metadata fields to merge into the order
Output
​
order_id
integer | null
Update the status of an order.Input
​
order_id
integer
required
min: > 0.
​
status
enum (`pending`, `confirmed`, `complete`)
required
New order status
Output
​
order_id
integer | null
​
previous_status
string | null
​
new_status
string | null
Update an order’s shipping address.Input
​
order_uid
string
required
​
line1
string
required
​
city
string
required
​
postal_code
string
required
​
country
string
required
​
line2
string | null
​
state
string | null
Output
​
order_id
integer | null

​
Payments

Retrieve all payments for an invoice.Input
​
invoice_id
integer
required
min: > 0.
​
limit
integer
min: 1, max: 50. Default: 10.
Output
​
invoice_id
integer | null
​
payments
PaymentSummary[]
​
total_count
integer
Retrieve payment details by UID.Input
​
payment_uid
string
required
Output
​
payment_id
integer | null
​
payment_uid
string | null
​
invoice_id
integer | null
​
status
string | null
​
amount
integer | null
​
currency
string | null
​
payment_provider
string | null
​
payment_method
string | null
​
card_brand
string | null
​
card_last4
string | null
​
transaction_id
string | null
​
failure_code
string | null
​
failure_message
string | null

​
Products

Archive a product deliverable.Input
​
deliverable_uid
string
required
Output
​
deliverable_uid
string | null
Archive a product to hide it from the store.Input
​
product_uid
string
required
Output
​
product_uid
string | null
Create a new product deliverable in the workspace.Input
​
type
string
required
​
name
string
required
​
config
object | null
Output
​
deliverable_uid
string | null
​
name
string | null
Create a new price for a product variant.Input
​
variant_uid
string
required
​
name
string | null
​
amount
number
required
min: > 0.
​
currency
string
Default: "USD".
​
recurring_interval
string | null
​
is_default
boolean
Default: false.
Output
​
price_uid
string | null
​
is_default
boolean | null
Create a new product in the store with optional price and images.Input
​
name
string
required
​
handle
string
required
​
description
string | null
​
tagline
string | null
​
price
number | null
​
currency
string | null
​
image_urls
string[]
Output
​
product_uid
string | null
​
name
string | null
​
handle
string | null
Retrieve product details by UID.Input
​
product_uid
string
required
Output
​
product_id
integer | null
​
product_uid
string | null
​
name
string | null
​
handle
string | null
​
description
string | null
​
is_published
boolean | null
​
is_archived
boolean | null
​
default_variant
ProductVariantOutput | null
Publish a product to make it visible in the store.Input
​
product_uid
string
required
Output
​
product_uid
string | null
​
name
string | null
Mark a price as the default for its variant.Input
​
price_uid
string
required
Output
​
price_uid
string | null
Restore an archived product.Input
​
product_uid
string
required
Output
​
product_uid
string | null
Update a product deliverable’s name, type, or config.Input
​
deliverable_uid
string
required
​
name
string | null
​
type
string | null
​
config
object | null
Output
​
deliverable_uid
string | null
Update an existing product’s details.Input
​
product_uid
string
required
​
name
string | null
​
handle
string | null
​
description
string | null
​
tagline
string | null
Output
​
product_uid
string | null
​
name
string | null
Update the default price of a product.Input
​
product_uid
string
required
​
price
number
required
min: > 0.
​
currency
string | null
Output
​
product_uid
string | null
​
price_uid
string | null
​
new_price
number | null
​
currency
string | null