Connecting through the REST API

    5 min read
    ·
    456 views
    ·
    Updated 10/23/2026

    ⚙️ Connecting through the REST API

    The API connector lets you integrate WazzaBee with any system you run: a CRM, an ERP, a website, a bot or a mobile app. Through the REST API you can send and receive messages, manage contacts and get notifications via webhooks.


    🔌 How to connect

    1. Go to Connectors
    2. Click the API card
    3. Click the Connect button
    4. Wait a few seconds. The system creates the integration and generates an API key for you
    5. You will see ✅ “Integration connected”
    6. Click “Go to settings”
    There is nothing extra to fill in: everything is generated automatically!

    🔑 The API key

    Once connected, you get an API key: a unique token that authorises your requests.

    How to get the key

    1. In the API connector settings find the “API key” card
    2. Click the 👁️ (eye) icon to reveal the key
    3. Click Copy: the key goes to your clipboard
    Important: never share your API key! If it has been exposed, click Refresh to generate a new one. The old key stops working right away.

    📡 Linking channels

    Choose which messengers will be available through the API:

    1. In the settings find the Channels card
    2. You will see the list of messengers you have connected
    3. Each one has a toggle (on/off)
    4. Turn on the channels you want to use through the API

    📚 How to use the API

    Every request uses a Bearer token in the header:

    Authorization: Bearer YOUR_API_KEY

    Available methods

    MethodURLDescription
    GET/v1/accountAccount details
    GET/v1/channelsList of linked channels
    GET/v1/contactsList of contacts
    GET/v1/conversationsList of conversations
    POST/v1/messages/sendSend a message
    PATCH/v1/webhooksRegister a webhook
    DELETE/v1/webhooksDelete a webhook

    Full documentation: API documentation →


    🔔 Webhooks: receiving events

    Set up webhooks to get notified about new messages in real time:

    SubscriptionWhat you receive
    messages_incomingIncoming messages from customers
    messages_outgoingOutgoing messages (the ones you send)
    contactsAndDealsCreationNew contacts and conversations being created

    ⚠️ Managing the connector

    • Disable: the API key stops working, but your settings are kept
    • Delete: removes everything (you have to disable it first)
    • Refresh the key: generates a new key (the old one stops working)
    Need a hand with the integration? Write to support, we will help you set it up!