Returnless template: Retrieving order status

By using this template, you can seamlessly connect to your Returnless account to retrieve order status information and use it in your chatbot when customers ask for it. The template is prefilled with essential information, however, you will need to fill out some specific details to connect to your Returnless account.

1. Access the template

In your chatbot in Pulse, navigate to Actions. Select the Returnless template.
This template includes prefilled information necessary for retrieving order information from your Returnless database.

2. Fill in the required fields

• Base URL: The Base URL is already filled in for you.

• Authentication: Add your API-Key under Token.
  To create a new API key, follow these steps:

  • Login to your Return panel and navigate to the Integrations menu.
  • Click the API keys tab.
  • Click the Create API key button, a modal will open to configure your new API key.
  

• Health Check URL and Instruction:

  • Health Check URL: Define a health check URL to monitor the status of the external server. This URL checks if the server is online.
    The Health Check URL is similar to the BaseURL and can be constructed by appending the health check endpoint to your base URL. Example of a Health Check URL:

  https://example.com/api/v1/health_check
  

  • Health Check Instruction: Add an instruction for the chatbot to follow if the server is not online. For example, you can instruct the chatbot to respond with: "Sorry, something went wrong on our end. Can I assist you with anything else?"

❗️

Note: Ensure that the health check is not secured, otherwise the action cannot access it.

This ensures that at Returnless you cannot check if the API is still running or if it has, for example, timed out.

3. Optional: Update the Schema

The template already has a filled-in schema, so you can use it right away. If you want, you can change the schema to fit other purposes.

4. Validating your Action

After filling in the required details and schema:

• Validate: Click Validate to check for any errors in your schema. Correct any issues that are identified.
• Available Actions: Once validated, the available actions will be displayed.