Skip to content
ShopAssistShopAssist home

Connect ShopAssist to your own systems

API keys with scopes, signed outgoing webhooks for conversations, leads and handoffs, a Catalog Push API and order reports for attribution.

The API

  • Keys with scopes such as conversations, leads, analytics and knowledge
  • Read conversations, handoffs, CSAT, leads and back-in-stock subscriptions
  • Upsert FAQ entries in the knowledge base
  • The Catalog Push API for stores without a plugin
  • Order reports for assisted-revenue attribution
  • Privacy requests for access and deletion
  • AI content verification: check whether a text was generated by your assistant

Outgoing webhooks

Signed events such as conversation created, lead captured and handoff requested, with retries and automatic disabling of failing endpoints. The event catalog and payload schemas are in the docs.

Plan access

API access and webhooks depend on your plan. Endpoints for the data path, privacy and store reads are never gated.

Frequently asked questions

Which API endpoints are available on every plan?

The Catalog Push API, order reports for attribution, privacy requests and store reads work on every plan. Other endpoints follow your plan's API access level.

How are webhooks signed?

Every delivery carries an HMAC-SHA256 signature with a timestamp. The docs have verification code for Python, Node.js and PHP.

Try it on your store.

Free with your own AI key.