Configure the “API” action in SimplePearl and AdvancedPearl to fetch or update data during a live conversation.
HTTP Method
URL
Headers
Content-Type
, Authorization
, etc.Body
customer.address.street
).
Arrays can be represented using square brackets with an index (e.g., order.items[0].productId
). see bellow Nested objects.customer.address.street
)order.items[0].productId
)API key | Variable |
---|---|
customer.name | customerName |
customer.email | customerEmail |
customer.address.street | street |
customer.address.city | city |
order.items[0].productId | productId |
order.items[0].quantity | quantity |
1. Create a Credential
2. Fill Credential Details
Content-Type: application/json
) for the token requestgrant_type
, client_id
, client_secret
)token path
: JSONPath to locate the token in the API response (e.g. “response.access_token”)ttl
: time‑to‑live for the token (default 300 seconds; adjust if needed)header key
: name of the header where the token will be injected (e.g. Authorization
)header prefix
: optional prefix for the token (e.g. Bearer
or Basic
)3. Test Credential
header key
and optional header prefix
.ttl
.token path
you enter corresponds to the exact location of the token in the JSON response.Assign Test Values
Run Test API
Inspect