Quick Start

This quick start helps you launch your first customer conversation flow in Bread Crumbs. You will connect a channel, configure an AI assistant, verify the inbox flow, invite team members to the workspace, and run your first authenticated API request.

By the end of this guide

One channel connected
One successful inbound/outbound test message
Crumby assistant configured
Inviting team members to the workspace
One authenticated API request working

Prerequisites

Access to a Bread Crumbs workspace
At least one provider account (WhatsApp, Instagram, or Telegram)
An API key from the dashboard: API Keys

Step 1: Connect your first channel (Portal)

Open the Channels page: https://app.bcrumbs.net/management/integration
Create or connect one channel (WhatsApp, Instagram, Telegram, or Custom)
Complete any provider-side verification/setup steps

You should now see your channel listed as connected/active in the Channels page.

Step 2: Configure AI assistant

Add knowledge data from:
- https://app.bcrumbs.net/ai/sources/files
- https://app.bcrumbs.net/ai/sources/text
Test Crumby in playground: https://app.bcrumbs.net/ai/playground
Open channel settings from Channels and set conversation start behavior to Crumby
Start a new channel conversation and verify Crumby responds

You should now have AI replying in new conversations for the configured channel.

Step 3: Send a test message and verify in Inbox

Open Inbox and locate the test conversation
Send one outbound test message from your team/agent
Verify:
- a new conversation appears in the conversation list
- inbound message appears in chat panel
- you can reply to the inbound message
- outbound message is delivered
- you can click the three dots menu and assign Crumby to the conversation
- assignment/AI behavior works as expected

You should now have an end-to-end validated conversation flow.

Step 4: Invite team members

Open the workspace members page: https://app.bcrumbs.net/account/workspace
Invite teammates by email and assign the proper role (for example: Admin, Manager, or Agent)
Ask them to accept the invitation and sign in

You should now see your team members in the workspace and they can participate in conversations. For more information about workspace roles, see Workspace Roles.

Step 5: Optional - Make your first API call

Use your API key as the authorization header.

curl 'https://gateway.bcrumbs.net/core/gq' \
  -H 'authorization: API-KEY' \
  -H 'content-type: application/json' \
  --data-raw '{"operationName":"convs","variables":{"input":{"workspaceId":12}},"query":"query convs($input: ConvsInput!) { convs(input: $input) { nodes { id createdAt } } }"}'

You should receive a valid GraphQL JSON response with data.convs.

Step 6: Optional - Next integrations

Configure webhook events: Webhooks API
Use cursor-based pagination for list endpoints: Pagination
Read more about the APIs: APIs
Read more about embedded inbox integration: Embedded Inbox

Troubleshooting quick checks

Channel not receiving events
- Recheck channel state in portal and try to integrate again
Invalid API key / auth
- Ensure authorization header is present and uses an active API key
AI not responding
- Verify AI source data is available and channel start behavior is set to Crumby

Nothing seems to be working? Contact us at [email protected] and we’ll help you out. Or you can contact us on our support channel in WhatsApp.

Next steps

More information about concepts: Concepts
More information about the portal: Portal
API Reference home: APIs
Channels API: Channels
Conversations API: Conversations
Webhooks API: Webhooks

Getting Started Concepts