Beta
Idempotent

Create task

​

Enqueue a one-off registry task. Find available actions with the registry-actions endpoint.

Headers
  • x-corma-idempotency-key
    Type: string
    min length:  
    1

    Optional client-generated key. Reusing the same key with an identical request replays the original response instead of enqueueing a duplicate task.

Body·
required
application/json
  • actionIdentifier
    Type: string
    required

    The identifier of the registry action to execute. Query the registry-actions endpoint to get the list of available actions.

  • payload
    Type: object
    required

    The payload of the registry action to execute. Must conform to the payloadSchema returned by registry-actions for the chosen action.

    Empty object
Responses
  • 202
    Type: object ·

    OK

    • actionIdentifier
      Type: string
      required
    • createdAt
      Type: string Format: date-time
      required

      The timestamp of when this resource was created. ISO 8601 format.

    • errorMessage
      Type: string nullable
      required
    • id
      Type: integer
      min:  
      -9007199254740991
      max:  
      9007199254740991
      required

      Integer numbers.

    • payload
      Type: object
      required
      Empty object
    • status
      Type: string · enum
      required
      values
      • draft
      • todo
      • ongoing
      • completed
      • declined
      • errored
    • triggeredBy
      Type: object · nullable
      required
    • updatedAt
      Type: string Format: date-time
      required

      The timestamp of the last update to this resource. ISO 8601 format.

    application/json
post/tasks
{
  "id": -9007199254740991,
  "status": "draft",
  "actionIdentifier": "string",
  "payload": {},
  "errorMessage": "string",
  "triggeredBy": {
    "id": "string",
    "type": "employee",
    "email": "string",
    "personalEmail": "string",
    "name": "string",
    "idpStatus": "active",
    "hrStatus": "active",
    "jobKey": "string",
    "countryCode": "string",
    "teamKey": "string",
    "startDate": "2026-07-23T16:23:32.922Z",
    "terminationDate": "2026-07-23T16:23:32.922Z"
  },
  "createdAt": "2026-07-23T16:23:32.922Z",
  "updatedAt": "2026-07-23T16:23:32.922Z"
}

OK