Easy!Appointments

Consume Easy!Appointments API

Actions38

Overview

The Easy!Appointments node for n8n allows you to interact with the Easy!Appointments API. Specifically, the Working Plan → Update operation lets you update the working plan (schedule) of a specific provider. This is useful in scenarios where you need to programmatically adjust a provider's availability, such as updating business hours, adding breaks, or changing workdays.

Practical examples:

  • Automatically adjusting a provider’s schedule based on external calendar events.
  • Bulk updating working plans for multiple providers after a policy change.
  • Integrating HR systems to synchronize staff working hours with Easy!Appointments.

Properties

Name Type Meaning
Provider ID String The unique identifier of the provider whose working plan you want to update.
Working Plan JSON The new working plan data in JSON format. Example:
{"monday":{"start":"09:00","end":"18:00","breaks":[{"start":"12:00","end":"13:00"}]},"tuesday":{"start":"09:00","end":"18:00","breaks":[]},...}

Output

  • The output will be a JSON object representing the updated working plan for the specified provider, as returned by the Easy!Appointments API.
  • The structure typically mirrors the input workingPlan property, possibly including additional metadata from the API.

Example output:

{
  "workingPlan": {
    "monday": {
      "start": "09:00",
      "end": "18:00",
      "breaks": [
        { "start": "12:00", "end": "13:00" }
      ]
    },
    "tuesday": {
      "start": "09:00",
      "end": "18:00",
      "breaks": []
    }
    // ... other days
  },
  "providerId": "123",
  // ... possible additional fields
}

Dependencies

  • External Service: Requires access to an Easy!Appointments instance with API enabled.
  • API Credentials: You must configure the easyAppointmentsApi credential in n8n, which includes:
    • Base URL of your Easy!Appointments installation
    • Username and password for authentication

Troubleshooting

Common issues:

  • Invalid Provider ID: If the Provider ID does not exist, the API will return an error.
  • Malformed Working Plan: If the Working Plan JSON is invalid or missing required fields, the API may reject the request.
  • Authentication Errors: Incorrect credentials or base URL will result in authentication failures.

Error messages and resolutions:

  • "Base URL is required": Ensure the Easy!Appointments API URL is set correctly in your credentials.
  • "error": "Not Found": Check that the Provider ID exists and is correct.
  • "error": "Unauthorized": Verify your username and password in the credentials.
  • "error": "Invalid working plan format": Double-check your JSON structure for the Working Plan.

Links and References


Discussion