Skip to main content

API Call

Set up custom integrations so the chatbot can fetch or send information in real time (e.g.: check order status, retrieve products, create support tickets).

You can add multiple endpoints, respecting your plan's active action limit.

Endpoint Details​

Define the base identity of your request:

  • Endpoint name: A descriptive name (e.g.: Find customer by email).
  • Method: GET, POST, PUT, DELETE, etc.
  • URL: The resource address in the external API.

Authentication​

If your API requires security, click the Authentication button to open the settings modal:

  • Authentication Method and URL: Defines where WiseMind should fetch the token.
  • Body and Headers: Send the required credentials (e.g.: username and password in JSON format).
  • Token path in response: Dot notation to extract the token (e.g.: data.access_token).
  • Expires in (s): Token lifetime so WiseMind knows when to renew it.

Usage and Post-Execution Instructions​

Guide WiseMind on integration behavior:

  • When should this action be used?

    Explain the ideal scenario. E.g.: "Use this action when the customer wants to check an order status. Ask for their CPF before calling the API."

  • Post-execution instructions

    Explain how the assistant should handle the response. E.g.: "Summarize the API response in a user-friendly list format and ask if the customer needs anything else."

Additional Data​

Add optional fields sent in the request when needed. The panel is split into tabs:

  • Headers, Body, Path Params, Querystring
  • You can add multiple items by setting Key and Value in each tab.

Identified user data​

If your site uses User Identification, the verified JWT claims become available in any field of the request (URL, Headers, Body, Path Params, Querystring) through the {{identity.<claim>}} syntax.

Examples:

GET https://api.yoursite.com/customers/{{identity.account_id}}/orders
Authorization: Bearer {{identity.api_token}}

Values are only interpolated after the token signature is verified. If the token is missing, expired, or invalid, the action is not executed.

Test Endpoint

Before saving, you can expand the Test Endpoint section to simulate a real request with sample values and verify that the configuration is correct.