Actions14
Overview
This node integrates with the Nookal practice management system via its GraphQL API, allowing users to manage healthcare-related data such as patients, appointments, practitioners, and locations. Specifically, for the Appointment - Cancel operation, the node enables cancelling an existing appointment by its ID.
This is useful in scenarios where appointments need to be programmatically cancelled due to patient requests, scheduling conflicts, or automated workflows that manage appointment statuses. For example, a clinic could automate cancellation notifications or update their calendar system when an appointment is cancelled through this node.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the appointment to cancel. This is required to specify which appointment should be cancelled. |
Output
The output JSON contains the result of the cancellation mutation. It includes:
appointment: An object with:id: The ID of the cancelled appointment.status: The updated status of the appointment after cancellation.updatedAt: Timestamp indicating when the appointment was last updated.
errors: An array of error objects (if any), each containing:field: The field related to the error.message: A descriptive error message.
No binary data is output by this operation.
Example output structure:
{
"cancelAppointment": {
"appointment": {
"id": "appointment-id",
"status": "CANCELLED",
"updatedAt": "2024-01-01T12:00:00Z"
},
"errors": []
}
}
Dependencies
- Requires an active connection to the Nookal practice management system via its GraphQL API.
- Requires an API authentication credential configured in n8n (an OAuth2 or API key credential).
- The node uses internal helper functions to send GraphQL queries/mutations to Nookal's API endpoint.
Troubleshooting
Common issues:
- Providing an invalid or non-existent appointment ID will likely cause an error or return no appointment.
- Network or authentication failures can prevent the request from succeeding.
- Malformed input parameters may cause the API to reject the request.
Error messages:
"Unknown appointment operation: cancel": Indicates the operation parameter was not recognized; ensure "cancel" is selected.- Errors returned in the
errorsarray in the response indicate validation or processing issues; check thefieldandmessagefor details. "Invalid JSON in variables field": Not applicable here but relevant if using custom queries with variables.
Resolution tips:
- Verify the appointment ID exists and is correct.
- Ensure API credentials are valid and have sufficient permissions.
- Check network connectivity and API endpoint availability.
- Review error messages returned in the output for specific guidance.
Links and References
- Nookal API Documentation (for detailed API schema and usage)
- GraphQL Basics (to understand query and mutation structure)
- n8n documentation on creating custom nodes