Scheduled Temporal ping

POST

/dev/agent/ping-schedule/v1

POST

/dev/agent/ping-schedule/v1

1 const url = 'https://localhost:8000/dev/agent/ping-schedule/v1';
2 const options = {
3   method: 'POST',
4   headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "schedule_id": "sched-1234abcd",
3   "ping_id": "ping-5678efgh",
4   "message": "Scheduled ping for developer diagnostics",
5   "workflow_name": "developer_ping_workflow",
6   "workflow_id": "workflow-9012ijkl",
7   "task_queue": "dev-ping-queue",
8   "schedule_spec": {
9     "calendars": [
10       {},
11       {}
12     ],
13     "intervals": [
14       {
15         "every": "PT15M"
16       }
17     ],
18     "cron_expressions": [
19       "0 9 * * *"
20     ],
21     "skip": [
22       {}
23     ],
24     "start_at": "2024-01-15T09:30:00Z",
25     "end_at": "2024-12-31T23:59:59Z",
26     "jitter": "PT5M",
27     "time_zone_name": "America/Los_Angeles"
28   },
29   "catchup_window_seconds": 60,
30   "created": true,
31   "next_action_times": [
32     "2024-01-15T09:30:00Z",
33     "2024-01-15T09:45:00Z"
34   ]
35 }

Creates or updates a Temporal Schedule that runs the scheduled ping workflow for developer diagnostics. | authz: min_org_role=administrator | (ScheduledPingReq) -> (ScheduledPingRes)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

messagestringOptional1-120 charactersDefaults to hello from scheduled ping

schedule_specobjectOptional

catchup_window_secondsintegerOptional>=10Defaults to 60

Response

Successful Response

schedule_idstring

ping_idstring

messagestring

workflow_namestring

workflow_idstring

task_queuestring

schedule_specobject

catchup_window_secondsinteger

createdboolean

next_action_timeslist of datetimes

Errors

422

Dev Post Agent Ping Schedule V1request Unprocessable Entity Error