hog_flows

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

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/hog_flows/{id}/invocations/
  • 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

globalsobject

Test trigger payload, typically {event, person, groups}. Shape it like the trigger's real payload: an event matching the trigger filters for event triggers, or for an internal-event trigger an event named in its filters.events (e.g. $slack_message_received with Slack properties like channel, user, text, ts) and no person.

mock_async_functionsboolean

True (default) mocks HTTP/email/SMS. False fires real side effects.

current_action_idstring

Start execution from this action ID instead of the trigger. Each test run executes a single node and returns the next action id.

use_draftboolean

Test the workflow's staged draft instead of its live config. Set this only when workflows-get returns a non-null 'draft'; it can't be combined with an explicit configuration override.

Response

No response body

Changes

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