External HTTP API Integration in Bot Flow Guide

Sendwo empowers you to expand your chatbot's capabilities by seamlessly integrating external APIs within the Flow Builder. This powerful feature bridges the gap between Sendwo and other platforms, enabling you to perform a wide range of actions, including data retrieval, form submissions, and user updates.

Sendwo's robust HTTP API integration ensures compatibility with a variety of external platforms, such as WooCommerce and WordPress, streamlining your chatbot's interactions and enhancing its overall functionality. Whether you want to display WooCommerce products in WhatsApp or integrate WordPress posts with WhatsApp, we've got you covered with step-by-step guides:

How to Display WooCommerce Products Inside WhatsApp

How to Display Dynamic List in WhatsApp Interactive Message

Step 1: Access the HTTP API Section

To create a new WhatsApp HTTP API connection in Sendwo:

1. Navigate: In the Sendwo dashboard, go to Integration > HTTP API.
2. View/Add: This section displays your existing API connections and allows you to add new ones.
3. Create: Click the "Create" button to begin setting up a new API connection.

Step 2: Add API Connection Details

In this section, you will configure the API settings to connect with external services:

1. API Name: Provide a recognizable name for your API connection (e.g., "WordPress User Create").
2. Method: Select the appropriate HTTP method (e.g., POST, GET) that matches the external API’s requirements.
3. Endpoint URL: Enter the full URL of the external API that you want to connect to (e.g., https://example.com/api/v1/users/create).
4. Test Subscriber ID:  Put a subscriber id copying from subscriber manager. Use your own phone number subscriber id. This is actually used for calling the API during verification. As some data may needed for dyanmic to pass custom field data or system field data. So for this test purpose at the first time, just put a testing subscriber ID.

Step 3: Configure Request Headers

In this section, you need to define any required HTTP headers needed to make the API request:

1. Content-Type: Set this to application/json or another content type, depending on the API specifications.
2. Authorization: If the API requires authorization (e.g., Basic Auth, Bearer Token), add the relevant header with the necessary token or credentials.
   • Example: Authorization: Bearer

Step 4: Configure Request Body (Optional)

If the API request requires data to be sent in the body (for POST/PUT requests), configure the fields here:

1. Body Data Fields: Add the necessary fields for the API request.
   • For instance, in the screenshot, the body includes user data such as username, first_name, last_name, and email.
   • You can define whether each field is a static value (fixed value) or dynamic value (pulled from user input or external data).
2. You can switch between form data, X-WWW-FORM-URLENCODED, and raw formats depending on the API requirements.

Step 5: Save and Verify the Connection

Once you have entered all the required fields:

1. Click on the "Verify Connection" button. Sendwo will send a test request to the external API to ensure everything is configured correctly.
2. Once verified, click Save API to finalize the connection.

Step 6: Map API Response Data

After a successful API connection, you can map the response data back into your workflow:

1. HTTP API Response Mapping: This section allows you to map fields from the API’s response to subscriber data or other variables within Sendwo.
   • For example, if the API returns a user_id or email, you can map this back to the subscriber’s profile in Sendwo.
   • You can also save List Items. It will be saved as JSON. And this value can be used for creating dynamic list for interactive message for WhatsApp bot flow.

Step 7: Use in Flow Builder

Once your API is integrated and the response mapping is set up, you can now use this API connection within your Flow Builder to trigger API calls at different points in your chatbot’s conversation flow.

1. HTTP API Element : Inside the Flow Builder, You can add HTTP API Element anywhere you want.
2. Configure when and how the API should be called based on user interactions.

Summary

Seamlessly integrate external APIs into your Sendwo workflows. This empowers you to automate actions like user creation, subscriber data retrieval, and real-time updates to external systems directly within your Sendwo chatbot flows.

For in-depth guidance on connecting APIs, advanced settings, and troubleshooting, please reach out to our support team or explore our comprehensive help center resources.