Documentation
Get started with documentation and helpful guides
for using the Zigglz developer API, embedding the Zigglz button, and more
Getting started with Zigglz
IMPORTANT! Before using the Zigglz API, embeddable button, or other tools, make sure you have an active account and subscription plan with Zigglz and that your MCP server published and live
After your account is created with Zigglz, you can log into your account with your email and password (or code). The console allows you to launch AI sites your team can log in to, monitor AI agents, manage settings, and more.
Once you completed the setup wizard, launch a new site, and invite team members to use it, your site will be live on a dedicated url. You can pause, unpause, manage users, and troubleshoot from the console. You can also add agent profiles to use with AI agents or set a default profile for all agents.
Keep in mind that only active (unpaused) versions of your sites will be available to users
The Zigglz console also lets you manage settings such as billing, AI agent settings, as well as invite team members to collaborate on managing Zigglz with different permissions. To log in to the console, visit the following link:
EpsressoCloud supports multiple data sources that your can connect to Zigglz so that the data from these is included in the data used by AI when user prompt or when AI agents are performing their tasks. To connect a data source, go to the Integrations section in the Zigglz console and search for your data source.
PLEASE NOTE: If a data source you would like to connect to Zigglz is not currently supported, Zigglz can develop this integration for you at an addtional cost
To enquire about custom integration options and custom development, please contact our support team via your account or Sign up if you do not already have an account:
The Zigglz API allows interaction with the service to synchronize products, orders, customers and more between your systems and Zigglz. Below are instructions on authorizing requets and the main RESTful API endpoints available with the API:
AUTHORIZATION:
HEADER 'x-api-key' : YOUR_API_KEY
To make authorized API requets, use the API Key for your site in the headers of your request as the value for the 'x-api-key' and your site ID as the value for 'x-site-id'. Each site has a different API Key.
You can obtain an API key and view your site ID in the Zigglz console 'Integrations' section
GETTING ORDERS:
POST https://api.zigglz.com/v1/getorders
Retrieves a list of orders with a specific status.
Orders that were completed more than 90 days ago will not be returned in this API
Example request properties:
"status": "submitted", //The status of the orders you want to retrieve. Can be "submitted", "validating", "offered", "accepted", "rejected", "preparing", "pending_pickup", "delivering", "arrived", or "complete".
"limit": 10, //The anmount of orders you want to be returned in one page
"start_key": "LAST_KEY" || null, //This is used to get the next page of orders
Example response:
{
"orders": [
{
... order properties ...
}
],
"lastKey": "LAST_KEY", //This is used to get the next page of orders by supplied it as the start_key in the next request
}
GETTING A SPECIFIC ORDER:
POST https://api.zigglz.com/v1/getorder
Retrieves a specific order. Expects request body with order_id.
Example request properties:
"order_id": "ORDER_ID"
Example response:
{
... order properties ...
}
Zigglz has convenient iOS and Android apps that allow you to easily manage your Zigglz account on the go. The apps have all the important functionality that the web console has including the ability to add team memebers or pause sites. To use the apps on your iPhone or Android device simply download them from the Apple App Store or Google Play Store.
PLEASE NOTE: The iOS app may not have billing management depending on your country. If you need to manage billing, please do so from the Zigglz web console