BackgroundJob

Defines a background job that is triggered on insertion of new record in background_jobs table.

Properties

• id: Unique identifier for the job. This field is auto-incremented.
• jobType (string): Type of the job. Must be one of: ['CUSTOM_PROPERTY_ENUM_CLEANUP', 'DELETE_ENTITY', 'DELETE_TOKEN'].
• methodName (string): JobHandler name of the method that will be executed for this job.
• jobArgs: Object containing job arguments.
• runAt: Timestamp when the job was run in Unix epoch time milliseconds (default: as soon as possible). Refer to ../type/basic.json#/definitions/timestamp.
• status (string): Current status of the job. Must be one of: ['COMPLETED', 'FAILED', 'RUNNING', 'PENDING'].
• createdBy (string): User or Bot who triggered the background job.
• createdAt: Timestamp when the job was created in Unix epoch time milliseconds. Refer to ../type/basic.json#/definitions/timestamp.
• updatedAt: Time when job was last updated in Unix epoch time milliseconds. Refer to ../type/basic.json#/definitions/timestamp.

Documentation file automatically generated at 2025-08-12 05:39:47.683420+00:00.