Creating a new Action

Creating a new Action requires configuring several elements: the endpoint to call, necessary parameters, HTTP method, and response handling. The process is guided and doesn't require advanced programming skills.

Accessing Action creation

1. From the main panel, click on "Actions" in the menu
2. If you don't have Actions yet, you'll see the "Create your first Action" button
3. If you already have other Actions, click on "Create New Action"
4. The guided configuration form will open

Required basic information

Action Name

• Purpose: Clearly identify the action for yourself and the assistant
• Effective examples:
  • "Create support ticket"
  • "Send welcome email"
  • "Check product availability"
  • "Book appointment"
• Tips: Use descriptive names that clearly indicate what the Action does

Action Description

• Importance: The AI uses this description to understand when to use the Action
• What to include:
  • When it should be used
  • What type of problems it solves
  • What information is needed
• Example: "Use this Action when the user wants to report a technical problem or request assistance. Requires: user email, problem description, problem category."

URL and method configuration

Endpoint URL

• Format: Complete URL of the API to call
• Examples:
  • https://api.myservice.com/tickets
  • https://mysite.com/api/appointments
  • https://webhook.example.com/contact
• Requirements: The URL must be publicly accessible and support HTTPS

HTTP Method

• GET: To retrieve information (e.g., availability check)
• POST: To create new resources (e.g., new ticket, new contact)
• PUT: To update existing resources
• DELETE: To delete resources (less common use)

Authentication management

Supported authentication types

• API Key in header: More secure, key in HTTP header
• API Key in URL: Less secure but simpler
• Bearer Token: JWT tokens or similar in Authorization header
• Basic Auth: Encoded username and password

Secure configuration

• Don't hardcode credentials: Use dedicated fields for API keys
• Always use HTTPS: Never send credentials over HTTP
• Key rotation: Periodically change API keys
• Minimum permissions: Grant only strictly necessary permissions

Step-by-step creation process

Step 1: Basic information

1. Enter descriptive Action name
2. Write detailed description for the AI
3. Select the type (if templates are available)

Step 2: Endpoint configuration

1. Enter complete API URL
2. Select appropriate HTTP method
3. Configure necessary headers (Content-Type, etc.)

Step 3: Authentication

1. Choose authentication type
2. Enter credentials in secure fields
3. Test connection if possible

Step 4: Parameters

1. Define parameters the Action should collect
2. Specify which are mandatory and which are optional
3. Set default values where appropriate

Step 5: Testing and validation

1. Use the integrated test function
2. Verify the response is as expected
3. Check error handling

Practical configuration examples

Email sending Action

Ticket creation Action

Common mistakes to avoid

• Inaccessible URLs: Verify that the endpoint is publicly reachable
• Wrong authentication: Always test credentials before saving
• Missing parameters: Make sure to define all necessary parameters
• Vague descriptions: The AI needs precise instructions to use the Action correctly
• Lack of error handling: Plan for what to do if the external API doesn't respond

Best practices

• Start simple: Create Actions for simple use cases first
• Test thoroughly: Verify all possible scenarios
• Document everything: Keep notes on how each Action works
• Monitor usage: Regularly check that Actions are working correctly
• Backup configurations: Save important settings