ScheduleTarget
ScheduleTarget describes the HTTP endpoint that receives each job invocation.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
url | string (uri) | Required in requests | Destination URL. Must be a valid absolute URI. Minimum length: 1. |
method | string | Optional | HTTP method to use. Defaults to "POST". |
kind | string | Required in requests | Logical kind used for routing and observability (e.g., "notification", "llm_conversation", "metering"). Required. Minimum length: 1. |
payload | Map from string to JSON value | Optional | Arbitrary JSON payload forwarded verbatim to the target. |
Request validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
url | Minimum length | 1 |
url | Uri | true |
kind | Minimum length | 1 |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
url | string | Required in requests | Destination URL. Must be a valid absolute URI. |
method | string | Optional | HTTP method to use. Defaults to "POST". |
kind | string | Required in requests | Logical kind used for routing and observability (e.g., "notification", "llm_conversation", "metering"). Required. |
payload | Map from string to JSON value | Optional | Arbitrary JSON payload forwarded verbatim to the target. |
Request validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
url | Minimum length | 1 |
url | Uri | true |
kind | Minimum length | 1 |
Where used
| Reference | Relationship |
|---|---|
| Create a scheduled job | POST /api/v1/scheduler/create-job |
| Update a scheduled job | POST /api/v1/scheduler/update-job |
| Get a scheduled job | POST /api/v1/scheduler/get-job |
| List scheduled jobs | POST /api/v1/scheduler/list-jobs |
| Pause a scheduled job | POST /api/v1/scheduler/pause-job |
| Resume a scheduled job | POST /api/v1/scheduler/resume-job |
| Schedule | Nested in model |
Download the public reference contract.
Document: DOC-API-MODEL-schedule-target.