Using the API Playground (Developer Settings)

The API Playground is an interactive sandbox for eGrow's developer API. You pick an action, fill in a simple form, and eGrow builds the exact API request for you — as a ready-to-copy cURL command or GraphQL query — then lets you Run it and see the live response. It's the fastest way to understand and test the API before you write a single line of integration code. Open it under Settings → Developer → Playground at https://v2.egrow.com/settings/developer/playground.

How the Playground is laid out

The screen is split in two:

• On one side, a form for the action you chose — the inputs the request needs.
• On the other, a live Request & Response pane that updates as you fill the form.

At the top you choose the Action you want to try. There are three:

Action 1: Send message

Send a message to a customer through a connected channel — exactly what your integration would do to reach someone on WhatsApp. Fill in:

• Connection (required) — which connected channel (e.g. a WhatsApp number) to send from.
• Recipient (required) — the customer to message.
• Message type — text, image, video, or email.
• Subject (email only) and the message body, or a media link/upload for image and video.

Action 2: Add order

Create an order through the API — the same call a store integration uses to push new orders into eGrow. The form mirrors a full order and is split into collapsible sections so it's not overwhelming:

• Order details — order number, external ID, abandoned-checkout URL, order type, pipeline/stage, financial status, store, and sales channel.
• Customer — the buyer's details.
• Line items — the products on the order.
• Discounts and Pricing.
• Shipping address, Billing address, and Contact.
• UTM — campaign attribution parameters.

You can Expand all / Collapse all sections, and use Fill dummy data to drop in realistic sample values so you can test the call in seconds without typing everything.

Action 3: Update stage

Move an existing order to a different stage in your pipeline — the call an external system would make to keep eGrow in sync (for example, marking an order shipped). Pick the order and the target stage.

Reading the request & running it

As you fill the form, the Request pane shows the call two ways — switch between:

• cURL — a complete curl -X POST command against the API endpoint, with the auth header and your data. Copy it and it runs as-is in your terminal.
• GraphQL — the underlying query/mutation document plus its Variables, if you prefer to work at that level.

Click Run to execute the request against the live API and see the Response JSON right below — the same response your integration would receive. You can copy the response too, and toggle a light/dark code theme for readability.

From Playground to production

Once a call works here, take it to your own code:

1. Copy the cURL (or the GraphQL document and variables).
2. Replace the Playground's auth with your own Personal API Key from Settings → Developer → API Key as a Bearer token.
3. Send it from your app, and handle the JSON response the same way you saw here.

Who uses this: your developer & your AI coding agent

The Playground is where you discover and test calls. There are two ways to then use the eGrow API in practice.

Your developer — the REST/GraphQL API

A developer builds directly against the API you just tested:

1. Prototype in the Playground — get the call working and copy its cURL (or the GraphQL document + variables).
2. Authenticate with a Personal API Key from Settings → Developer → API Key, sent as a Bearer token — or, for a third-party app acting on other accounts, an OAuth App from the OAuth Apps tab.
3. Call the endpoint from their code and handle the JSON response, exactly as seen in the Playground.

Everything the Playground does — send messages, create orders, move stages — is available programmatically, so your developer can wire eGrow into your website, ERP, or any backend.

Your AI coding agent — the MCP server

If you use an AI coding assistant (Claude, Cursor, and similar), eGrow ships a dedicated MCP server so the agent can talk to your account directly — reading and acting on your real data through a safe, structured set of tools. Set it up under Settings → Developer → MCP (https://v2.egrow.com/settings/developer/mcp).

• Server URL — https://mcp.egrow.com/mcp (HTTP transport).
• Authentication — OAuth (the agent signs in to eGrow, nothing to paste) or a token (your Personal API Key). The MCP tab gives you a ready config snippet to paste into your agent's settings, for example:

  {
   "mcpServers": {
   "egrow": { "type": "http", "url": "https://mcp.egrow.com/mcp" }
   }
  }

  For editors that need a local bridge, it also provides a stdio command: npx -y mcp-remote https://mcp.egrow.com/mcp.
• What the agent can do — around 40 tools grouped by area: Orders (11), Customers (10), Products (7), Discovery (4), Analytics (3), Escape hatch (3), and Pipelines (2). So you can simply ask, in plain language: "How many orders were delivered last week?", "Create an order for this customer," or "Which products have the best delivery rate?" — and the agent runs the right tools against your account.

What's next

Set up authentication in Settings → Developer → API Key, explore event-driven flows with automations, and connect your stack under Integrations & Developer.