How to use the Lightspeed Action template

This article will guide you through using the Lightspeed Action template.

By using this template, you can easily connect to your Lightspeed database and have your chatbot answer questions about order statuses. This template is prefilled with all necessary information, allowing you to seamlessly retrieve order status information.

Using the Lightspeed Action Template

Step 1: Access the Template

  1. In your chatbot in Pulse, navigate to Actions.
  2. Here, you can find and select the Lightspeed template. This template includes prefilled information necessary for retrieving order status information from your Lightspeed database.

Step 2: Fill in the Required Fields

  1. Base URL: Enter the URL for your Lightspeed API. This is the endpoint where the action will send requests to retrieve order status information.

    • Example of a URL: https://api-key:api-secret@api.webshopapp.com/language/
    • Replace api-key with your API key, api-secret with your API secret, and language with the language of your webshop (e.g., en, nl, etc.).
  2. Authentication: No authentication ('No auth') is needed for the Lightspeed Action (this is already done by including the API key and API secret in the Base URL).

  3. Health Check URL and Instruction: No health check is needed for the Lightspeed Action.

Step 3: Update the Schema

The template comes with a prefilled schema that serves as an example. You may need a developer to adjust it according to your specific requirements. Ensure that the schema is in .YML format and complies with at least OpenAPI version 3.0.0.

Step 4: Validating Your Action

After filling in the required details and schema:

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

You can use this article to help you save, publish and unpublish the action and test and use the action.