Overview
The BullMQ Respond node is designed to respond to jobs managed by a BullMQ queue system. It allows users to mark jobs as completed and provide the result data back to the queue. This node is useful in workflows where asynchronous job processing is involved, and you want to programmatically send the completion response for a specific job.
Common scenarios include:
- Completing background tasks that were queued and processed asynchronously.
- Sending results or output data back to a job after some processing in n8n.
- Integrating with BullMQ queues to manage job lifecycle within an automation workflow.
For example, if a previous node processes a file upload job, this node can be used to respond to that job with the processed file metadata, signaling the job's successful completion.
Properties
| Name | Meaning |
|---|---|
| Operation | The action to perform; currently only "Respond" is supported, which marks a job as completed. |
| Data Source | Selects the source of the data to respond with: either from the previous node's output ("Previous Node") or directly from the input ("Input"). |
| Job Data | When using "Input" as the data source, this defines the data assignments to send as the job's response. |
| Use Current Job's Data | Boolean flag indicating whether to use the current job's data to respond. (Currently not supported and must be set to false.) |
| Queue Name | The name of the BullMQ queue containing the job to respond to. Required when not using current job data. |
| Job ID | The identifier of the job to respond to. Required when not using current job data. |
| Lock Token | The lock token associated with the job, necessary if the job is locked. Usually obtained from a BullMQ Trigger node. |
Output
The node outputs an array of items corresponding to each input item processed. Each output item contains a json field representing the responded job's full JSON representation as returned by BullMQ. This includes all job details such as ID, data, status, timestamps, and logs.
No binary data is output by this node.
Dependencies
- Requires a Redis connection credential configured in n8n to connect to the BullMQ queue backend.
- Depends on the BullMQ library to interact with the queue and jobs.
- The node expects valid queue name, job ID, and lock token parameters to identify and respond to the correct job.
Troubleshooting
Error: "Queue Name, Job ID and Lock Token must be provided!"
This occurs if any of these required parameters are missing when "Use Current Job's Data" is disabled. Ensure all three are correctly set.Error:
Job with ID "<id>" does not exist!
Indicates the specified job ID was not found in the given queue. Verify the queue name and job ID are correct and that the job still exists.Using Current Job's Data Not Supported
If the "Use Current Job's Data" option is enabled, the node throws an error because this feature is not yet implemented. Disable this option and provide explicit queue name, job ID, and lock token instead.Redis Connection Issues
Since the node requires a Redis connection, ensure the credentials are valid and the Redis server is accessible.
Links and References
- BullMQ Documentation - Official docs for BullMQ queue management.
- n8n Redis Credential Setup - Guide on configuring Redis credentials in n8n.