Trigger Job Via Webhook

POST

/api/v1/webhooks/trigger/{process_id}

curl --request POST \
  --url https://nora-api.valisoftconsulting.com/api/v1/webhooks/trigger/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "machine_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "input_data": {} }'

• Producción

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

process_id

required

Process Id

string format: uuid

Request Body ^required

Media type application/json

WebhookTriggerRequest

object

machine_id

required

Machine Id

string format: uuid

input_data

Any of:

object

object

null

null

Example ^generated

{
  "machine_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "input_data": {}
}

Responses

201

Successful Response

Media type application/json

SuccessResponse[JobResponse]

object

success

Success

boolean

default: true

data

required

JobResponse

object

id

required

Id

string format: uuid

tenant_id

required

Tenant Id

string format: uuid

process_id

required

Process Id

string format: uuid

machine_id

required

Machine Id

string format: uuid

status

required

Status

string

priority

Priority

integer

default: 3

input_data

required

Any of:

object

object

null

null

output_data

required

Any of:

object

object

null

null

logs

required

Any of:

string

string

null

null

error_message

required

Any of:

string

string

null

null

started_at

required

Any of:

string

string format: date-time

null

null

finished_at

required

Any of:

string

string format: date-time

null

null

retry_count

required

Retry Count

integer

stop_requested

required

Stop Requested

boolean

logs_archived

Logs Archived

boolean

logs_archive_key

Any of:

string

string

null

null

is_attended

Is Attended

boolean

pending_input_prompt

Any of:

string

string

null

null

pending_input_options

Any of:

object

object

null

null

progress_percent

Any of:

integer

integer

null

null

progress_message

Any of:

string

string

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

process_name

Any of:

string

string

null

null

machine_name

Any of:

string

string

null

null

resource_metrics

Any of:

ResourceMetricsSchema

ResourceMetricsSchema

object

cpu_percent_avg

required

Cpu Percent Avg

number

cpu_percent_peak

required

Cpu Percent Peak

number

ram_mb_avg

required

Ram Mb Avg

number

ram_mb_peak

required

Ram Mb Peak

number

disk_read_mb

required

Disk Read Mb

number

disk_write_mb

required

Disk Write Mb

number

sample_count

required

Sample Count

integer

duration_seconds

required

Duration Seconds

number

null

null

trigger_id

Any of:

string

string format: uuid

null

null

schedule_id

Any of:

string

string format: uuid

null

null

Example

{
  "success": true,
  "data": {
    "priority": 3,
    "logs_archived": false,
    "is_attended": false
  }
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}