provider hog_flows PATCH /api/environments/{environment_id}/hog_flows/{id}/schedules/{schedule_id}/
@utdk/posthog /api/environments/{environment_id}/hog_flows/{id}/schedules/{schedule_id}/
environments_hog_flows_schedules_partial_update
environment_id path required
Deprecated. Use /api/projects/{project_id}/ instead.
string
id path required
A UUID string identifying this hog flow.
string
schedule_id path required
string

Try it

Authentication
Configure credentials for PostHog API
environmentsHogFlowsSchedulesPartialUpdate
PATCH/api/environments/{environment_id}/hog_flows/{id}/schedules/{schedule_id}/

Parameters

required

Deprecated. Use /api/projects/{project_id}/ instead.

required

A UUID string identifying this hog flow.

required

Input

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

ISO 8601 datetime the schedule starts from.

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

Variable value overrides merged with the workflow defaults on each run.

active, paused, or completed (set once the RRULE's COUNT/UNTIL is exhausted). * `active` - Active * `paused` - Paused * `completed` - Completed

Next scheduled fire time, computed by the scheduler.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.environmentsHogFlowsSchedulesPartialUpdate()