Home Eddie | Connect your backoffice Flow Testing in Eddie via API

Flow Testing in Eddie via API

Last updated on Aug 12, 2025

Eddie's API allows for automatic initiation and continuation of conversations using created flows through HTTP calls. This functionality is ideal for performing automated tests, validating interactions, and ensuring that the flows are working as expected.

This guide presents the complete process for using the API.

Overview of Integration

Communication with Eddie occurs in two main steps:

  1. Starting the conversation: creates a new chat session.

  2. Continuing the conversation: sends messages within the created session.

These calls are made through HTTP endpoints, using an authentication token and the ID of the flow created in Eddie.

Step-by-Step Integration

1. Obtain the Flow ID

Each flow created in Eddie has a unique identifier (ID) that is used to start the session via API. This ID can be copied directly from the flow's edit URL or the publication screen.

2. Start a New Chat Session

Endpoint:

POST https://eddieeyes.us-east-1.prd.cloudhumans.io/api/v1/typebots/FLOW_ID/startChat

Required Headers:

  • Content-Type: application/json

  • Authorization: Bearer {{apiToken}}

Expected Response:

{ "sessionId": "abc123xyz"}

This sessionId is essential for the next steps.

3. Send Messages to Continue the Chat

Endpoint:

POST https://eddieeyes.us-east-1.prd.cloudhumans.io/api/v1/sessions/{{sessionId}}/continueChat

Headers:

  • Content-Type: application/json

  • Authorization: Bearer {{apiToken}}

Body:

{ "message": "user's message"}

Response: a JSON object with the next interaction generated by Eddie based on the flow's logic.

How to Generate a Token

To authenticate calls via API, you need an API Token. Follow the steps below to generate one:

  1. Click on Settings and Members in the upper right corner of the screen.

  2. In the side menu, select My Account.

  3. In the API tokens section, click on Create to generate a new token.

Best Practices for Using the API

Storing and Reusing the sessionId

Keep the sessionId generated for each conversation. It is necessary to maintain continuity in the interaction with the same context.

Testing Before Final Integration

Use tools like Postman or Insomnia to validate the endpoints, headers, body, and responses. This helps avoid errors in the production environment.

Error Monitoring

Failures in calls (such as invalid data, incorrect endpoints, or timeouts) appear on the HUB with error signaling. Use this information for quick diagnosis.