hog_flows

post/api/projects/{project_id}/hog_flows/{id}/schedules/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/hog_flows/{id}/schedules/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this hog flow.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

idstring uuid required
rrulestring required

iCalendar RRULE string (e.g. 'FREQ=DAILY;INTERVAL=1'). Must produce occurrences at most once per hour.

starts_atstring date-time required

ISO 8601 datetime the schedule starts from.

timezonestring

IANA timezone for interpreting the RRULE (default 'UTC').

variablesunknown
status'active' | 'paused' | 'completed' required
  • active - Active
  • paused - Paused
  • completed - Completed
next_run_atstring date-time nullable required

Next scheduled fire time, computed by the scheduler.

created_atstring date-time required
updated_atstring date-time required

Response

idstring uuid required
rrulestring required

iCalendar RRULE string (e.g. 'FREQ=DAILY;INTERVAL=1'). Must produce occurrences at most once per hour.

starts_atstring date-time required

ISO 8601 datetime the schedule starts from.

timezonestring

IANA timezone for interpreting the RRULE (default 'UTC').

variablesunknown
status'active' | 'paused' | 'completed' required
  • active - Active
  • paused - Paused
  • completed - Completed
next_run_atstring date-time nullable required

Next scheduled fire time, computed by the scheduler.

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.