Skip to content
Layer Docs

Training Event

Viewing v2— current version

POST

Sent when a training run finishes or fails.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
TrainingWebhookEvent

Delivered when a training run reaches a terminal state.

object
id
required
Id

Unique event id, repeated in the webhook-id header.

string
type
required
WebhookEventType

Training.succeeded or training.failed.

string
Allowed values: inference.completed inference.failed inference.cancelled training.succeeded training.failed scoring_run.completed scoring_run.failed workflow_run.succeeded workflow_run.failed workflow_run.cancelled
created_at
required
Created At

When the event was raised (RFC 3339).

string
data
required
GetTrainingRunResponse

Identical to the body of GET on the training run.

object
training_run_id
required
Training Run Id
string format: uuid
state
required
State

In_progress, terminal_success, or terminal_failure.

string
Allowed values: in_progress terminal_success terminal_failure
raw_status
required
Raw Status

Fine-grained run status.

string
progress
required
Progress

Training progress in [0, 1]; 1.0 when complete.

number
poll_interval_seconds
Poll Interval Seconds

Suggested polling interval in seconds. Present while in_progress.

integer
nullable
eta_at
Eta At

Estimated completion time, if known.

string format: date-time
nullable
started_at
Started At
string format: date-time
nullable
finished_at
Finished At
string format: date-time
nullable
error
Error

Error message. Present only on terminal_failure.

string
nullable
error_code
Error Code

Machine-readable error code. Present on terminal_failure.

string
nullable
webhook
Any of:
WebhookStatusView

What a job’s GET reports about the callback attached to it.

The URL is echoed so a caller can tell which of its endpoints a run was aimed at; the rest is how the delivery went, which is the only place a failed delivery is visible.

object
url
required
Url

The callback URL this run was submitted with.

string
status
required
WebhookDeliveryStatus

Pending until a delivery settles, then delivered or failed.

string
Allowed values: pending delivered failed
attempts
required
Attempts

How many delivery attempts have been made.

integer
last_attempt_at
Last Attempt At

When the last attempt was made.

string format: date-time
nullable
last_response_status
Last Response Status

HTTP status the receiver returned on the last attempt, if it responded.

integer
nullable
last_error
Last Error

Why the last attempt did not succeed. Null once delivered.

string
nullable
metadata
Metadata

Whatever you sent as webhook.metadata.

object
key
additional properties
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Examplegenerated
example

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}