HIhify
Admin Jobs

Trigger a background job on demand

Admin-only endpoint that enqueues any ApplicationJob by class name. Accepts an optional params hash that is forwarded to the job (as keyword arguments by default, or transformed by a registered custom transformer).

post/v1/admin/jobs/trigger

Request

  • Base URL
    https://api.hify.club
  • Auth
    API key in header X-User-Token

Request body

jobstring required

The job class name to enqueue

paramsobject

Optional parameters to pass to the job. Shape depends on the job being triggered.

Example request

{
  "job": "MomentDetectionInitializerJob",
  "params": {
    "record_type": "OrderRequest",
    "record_id": 123
  }
}

Response

Job successfully enqueued

statusstring
jobstring

Example response

{
  "status": "queued",
  "job": "MomentDetectionInitializerJob"
}

Changes

No recorded changes to this operation across all 1 revision of this API.