ScheduleService gRPC API

ScheduleService provides runtime schedule management for gRPC plugins. Plugins use this to create, pause, resume, and delete recurring Pulse schedules.

Proto file: plugin/grpc/protocol/schedule.proto

Service Methods

Method	Request	Response	Streaming
CreateSchedule	CreateScheduleRequest	CreateScheduleResponse	No
PauseSchedule	PauseScheduleRequest	PauseScheduleResponse	No
ResumeSchedule	ResumeScheduleRequest	ResumeScheduleResponse	No
DeleteSchedule	DeleteScheduleRequest	DeleteScheduleResponse	No
GetSchedule	GetScheduleRequest	GetScheduleResponse	No

CreateSchedule

CreateSchedule creates a new recurring schedule in Pulse

Request: CreateScheduleRequest
Response: CreateScheduleResponse

PauseSchedule

PauseSchedule pauses an active schedule

Request: PauseScheduleRequest
Response: PauseScheduleResponse

ResumeSchedule

ResumeSchedule resumes a paused schedule

Request: ResumeScheduleRequest
Response: ResumeScheduleResponse

DeleteSchedule

DeleteSchedule soft-deletes a schedule

Request: DeleteScheduleRequest
Response: DeleteScheduleResponse

GetSchedule

GetSchedule retrieves a schedule by ID

Request: GetScheduleRequest
Response: GetScheduleResponse

Message Types

ScheduledJob

ScheduledJob represents a recurring Pulse schedule

Field	Type	Description
id	string	-
ats_code	string	-
handler_name	string	-
payload	bytes	-
source_url	string	-
interval_seconds	int32	-
next_run_at	string	-
last_run_at	string	-
last_execution_id	string	-
state	string	-
metadata	string	-
created_at	string	-
updated_at	string	-

CreateScheduleRequest

Field	Type	Description
auth_token	string	-
handler_name	string	-
interval_seconds	int32	-
payload	bytes	-
metadata	map<string, string>	-

CreateScheduleResponse

Field	Type	Description
success	bool	-
error	string	-
schedule_id	string	-

PauseScheduleRequest

Field	Type	Description
auth_token	string	-
schedule_id	string	-

PauseScheduleResponse

Field	Type	Description
success	bool	-
error	string	-

ResumeScheduleRequest

Field	Type	Description
auth_token	string	-
schedule_id	string	-

ResumeScheduleResponse

Field	Type	Description
success	bool	-
error	string	-

DeleteScheduleRequest

Field	Type	Description
auth_token	string	-
schedule_id	string	-

DeleteScheduleResponse

Field	Type	Description
success	bool	-
error	string	-

GetScheduleRequest

Field	Type	Description
auth_token	string	-
schedule_id	string	-

GetScheduleResponse

Field	Type	Description
success	bool	-
error	string	-
job	ScheduledJob	-

← Back to API Index