Actions
      Back to home
      1. Help Center
      2. Pulse
      3. Actions

      How to use the Sendcloud Action template

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

      By using this template, you can easily connect with your Sendcloud database to retrieve order status information. This template is prefilled with all necessary information, enabling you to automate conversations seamlessly. However, you will need to fill out some details yourself to connect to your specific database.

      Using the Sendcloud Action Template

      Step 1: Access the template

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

      Step 2: Fill in the required fields

      • BaseURL: Enter the BaseURL for your Sendcloud API. This is the endpoint where the action will send requests to retrieve order information.
        You can find the BaseURL by following these steps:
        1. Log in to your Sendcloud admin panel.
        2. Go to Settings > API > API Endpoints.
        3. Here, you will find the base URL. The base URL typically follows this format: https://yourdomain.com/api/v1/
          Example of a BaseURL: https://example.com/api/v1/
      • Authentication: Fill out the necessary credentials: 'public_key' and 'password'. These can be found using your Sendcloud API documentation.
      • 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.
          Similar to the Base URL, the Health Check URL 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?"

      Step 3: Update the Schema

      The template comes with a prefilled schema, giving you an example. You may need a developer to adjust it according to your specific requirements. Ensure the schema is in .YML format and compliant 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.