Actions11
Overview
This node interacts with a recruitment system's API to manage quiz sessions related to candidates. Specifically, the "Cancel Quizz Session" operation allows users to cancel an ongoing or scheduled quiz session for a candidate. This is useful in scenarios where a candidate should no longer participate in a quiz due to withdrawal, scheduling conflicts, or administrative decisions.
Practical examples include:
- Automatically cancelling a quiz session if a candidate withdraws from the recruitment process.
- Cancelling sessions that were scheduled by mistake or need rescheduling.
- Managing candidate quiz workflows dynamically based on recruitment status changes.
Properties
Name | Meaning |
---|---|
Session ID * | The unique identifier of the quiz session to be cancelled. This is a required string input. |
Output
The node outputs a JSON object representing the result of the cancellation request. This typically includes confirmation details such as the session ID and status indicating that the session was successfully cancelled. The exact structure depends on the API response but generally confirms the action taken.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential to authenticate with the Pulse recruitment API.
- The node depends on the external Pulse API service to perform operations on quiz sessions.
- Proper configuration of the API credentials within n8n is necessary for successful execution.
Troubleshooting
Common issues:
- Invalid or missing Session ID: Ensure the session ID provided exists and is correctly formatted.
- Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
- Network or API downtime: Check connectivity and Pulse API service status.
Error messages:
"The operation "cancelQuizzSession" is not supported for resource "quizzSessions"!"
— Indicates a misconfiguration or unsupported operation; verify the selected operation matches the resource.- Errors containing
"error"
in the JSON output usually indicate API-level failures; inspect the error message for details.
To resolve errors, confirm all inputs are correct, credentials are valid, and the Pulse API service is operational.
Links and References
- Pulse API Documentation (replace with actual URL)
- n8n documentation on Creating Custom Nodes