1. Packages
  2. Packages
  3. Rootly
  4. API Docs
  5. WorkflowPulse
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq
Schema (JSON)
rootlyhq/pulumi-rootly

rootly.WorkflowPulse

rootly logo
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq
Schema (JSON)
rootlyhq/pulumi-rootly

    Example Usage

    resource "rootly_workflow_pulse" "my-workflow" {
  name        = "Trigger when a pulse is created"
  description = "This workflow will trigger when a pulse is created"
  trigger_params {
    triggers = ["pulse_created"]

  }
  enabled = true
}

    Create WorkflowPulse Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new WorkflowPulse(name: string, args?: WorkflowPulseArgs, opts?: CustomResourceOptions);
    @overload
def WorkflowPulse(resource_name: str,
                  args: Optional[WorkflowPulseArgs] = None,
                  opts: Optional[ResourceOptions] = None)

@overload
def WorkflowPulse(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  cause_ids: Optional[Sequence[str]] = None,
                  command: Optional[str] = None,
                  command_feedback_enabled: Optional[bool] = None,
                  continuously_repeat: Optional[bool] = None,
                  description: Optional[str] = None,
                  enabled: Optional[bool] = None,
                  environment_ids: Optional[Sequence[str]] = None,
                  functionality_ids: Optional[Sequence[str]] = None,
                  group_ids: Optional[Sequence[str]] = None,
                  incident_role_ids: Optional[Sequence[str]] = None,
                  incident_type_ids: Optional[Sequence[str]] = None,
                  locked: Optional[bool] = None,
                  name: Optional[str] = None,
                  position: Optional[int] = None,
                  repeat_condition_duration_since_first_run: Optional[str] = None,
                  repeat_condition_number_of_repeats: Optional[int] = None,
                  repeat_every_duration: Optional[str] = None,
                  repeat_ons: Optional[Sequence[str]] = None,
                  service_ids: Optional[Sequence[str]] = None,
                  severity_ids: Optional[Sequence[str]] = None,
                  slug: Optional[str] = None,
                  sub_status_ids: Optional[Sequence[str]] = None,
                  trigger_params: Optional[WorkflowPulseTriggerParamsArgs] = None,
                  wait: Optional[str] = None,
                  workflow_group_id: Optional[str] = None)
    func NewWorkflowPulse(ctx *Context, name string, args *WorkflowPulseArgs, opts ...ResourceOption) (*WorkflowPulse, error)
    public WorkflowPulse(string name, WorkflowPulseArgs? args = null, CustomResourceOptions? opts = null)
    public WorkflowPulse(String name, WorkflowPulseArgs args)
public WorkflowPulse(String name, WorkflowPulseArgs args, CustomResourceOptions options)

    type: rootly:WorkflowPulse
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args WorkflowPulseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WorkflowPulseArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WorkflowPulseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowPulseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowPulseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var workflowPulseResource = new Rootly.WorkflowPulse("workflowPulseResource", new()
{
    CauseIds = new[]
    {
        "string",
    },
    Command = "string",
    CommandFeedbackEnabled = false,
    ContinuouslyRepeat = false,
    Description = "string",
    Enabled = false,
    EnvironmentIds = new[]
    {
        "string",
    },
    FunctionalityIds = new[]
    {
        "string",
    },
    GroupIds = new[]
    {
        "string",
    },
    IncidentRoleIds = new[]
    {
        "string",
    },
    IncidentTypeIds = new[]
    {
        "string",
    },
    Locked = false,
    Name = "string",
    Position = 0,
    RepeatConditionDurationSinceFirstRun = "string",
    RepeatConditionNumberOfRepeats = 0,
    RepeatEveryDuration = "string",
    RepeatOns = new[]
    {
        "string",
    },
    ServiceIds = new[]
    {
        "string",
    },
    SeverityIds = new[]
    {
        "string",
    },
    Slug = "string",
    SubStatusIds = new[]
    {
        "string",
    },
    TriggerParams = new Rootly.Inputs.WorkflowPulseTriggerParamsArgs
    {
        PulseCondition = "string",
        PulseConditionLabel = "string",
        PulseConditionLabelUseRegexp = false,
        PulseConditionPayload = "string",
        PulseConditionPayloadUseRegexp = false,
        PulseConditionSource = "string",
        PulseConditionSourceUseRegexp = false,
        PulseLabels = new[]
        {
            "string",
        },
        PulsePayloads = new[]
        {
            "string",
        },
        PulseQueryPayload = "string",
        PulseSources = new[]
        {
            "string",
        },
        TriggerType = "string",
        Triggers = new[]
        {
            "string",
        },
    },
    Wait = "string",
    WorkflowGroupId = "string",
});

    example, err := rootly.NewWorkflowPulse(ctx, "workflowPulseResource", &rootly.WorkflowPulseArgs{
	CauseIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Command:                pulumi.String("string"),
	CommandFeedbackEnabled: pulumi.Bool(false),
	ContinuouslyRepeat:     pulumi.Bool(false),
	Description:            pulumi.String("string"),
	Enabled:                pulumi.Bool(false),
	EnvironmentIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	FunctionalityIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	GroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	IncidentRoleIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	IncidentTypeIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Locked:                               pulumi.Bool(false),
	Name:                                 pulumi.String("string"),
	Position:                             pulumi.Int(0),
	RepeatConditionDurationSinceFirstRun: pulumi.String("string"),
	RepeatConditionNumberOfRepeats:       pulumi.Int(0),
	RepeatEveryDuration:                  pulumi.String("string"),
	RepeatOns: pulumi.StringArray{
		pulumi.String("string"),
	},
	ServiceIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	SeverityIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Slug: pulumi.String("string"),
	SubStatusIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	TriggerParams: &rootly.WorkflowPulseTriggerParamsArgs{
		PulseCondition:                 pulumi.String("string"),
		PulseConditionLabel:            pulumi.String("string"),
		PulseConditionLabelUseRegexp:   pulumi.Bool(false),
		PulseConditionPayload:          pulumi.String("string"),
		PulseConditionPayloadUseRegexp: pulumi.Bool(false),
		PulseConditionSource:           pulumi.String("string"),
		PulseConditionSourceUseRegexp:  pulumi.Bool(false),
		PulseLabels: pulumi.StringArray{
			pulumi.String("string"),
		},
		PulsePayloads: pulumi.StringArray{
			pulumi.String("string"),
		},
		PulseQueryPayload: pulumi.String("string"),
		PulseSources: pulumi.StringArray{
			pulumi.String("string"),
		},
		TriggerType: pulumi.String("string"),
		Triggers: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Wait:            pulumi.String("string"),
	WorkflowGroupId: pulumi.String("string"),
})

    var workflowPulseResource = new WorkflowPulse("workflowPulseResource", WorkflowPulseArgs.builder()
    .causeIds("string")
    .command("string")
    .commandFeedbackEnabled(false)
    .continuouslyRepeat(false)
    .description("string")
    .enabled(false)
    .environmentIds("string")
    .functionalityIds("string")
    .groupIds("string")
    .incidentRoleIds("string")
    .incidentTypeIds("string")
    .locked(false)
    .name("string")
    .position(0)
    .repeatConditionDurationSinceFirstRun("string")
    .repeatConditionNumberOfRepeats(0)
    .repeatEveryDuration("string")
    .repeatOns("string")
    .serviceIds("string")
    .severityIds("string")
    .slug("string")
    .subStatusIds("string")
    .triggerParams(WorkflowPulseTriggerParamsArgs.builder()
        .pulseCondition("string")
        .pulseConditionLabel("string")
        .pulseConditionLabelUseRegexp(false)
        .pulseConditionPayload("string")
        .pulseConditionPayloadUseRegexp(false)
        .pulseConditionSource("string")
        .pulseConditionSourceUseRegexp(false)
        .pulseLabels("string")
        .pulsePayloads("string")
        .pulseQueryPayload("string")
        .pulseSources("string")
        .triggerType("string")
        .triggers("string")
        .build())
    .wait("string")
    .workflowGroupId("string")
    .build());

    workflow_pulse_resource = rootly.WorkflowPulse("workflowPulseResource",
    cause_ids=["string"],
    command="string",
    command_feedback_enabled=False,
    continuously_repeat=False,
    description="string",
    enabled=False,
    environment_ids=["string"],
    functionality_ids=["string"],
    group_ids=["string"],
    incident_role_ids=["string"],
    incident_type_ids=["string"],
    locked=False,
    name="string",
    position=0,
    repeat_condition_duration_since_first_run="string",
    repeat_condition_number_of_repeats=0,
    repeat_every_duration="string",
    repeat_ons=["string"],
    service_ids=["string"],
    severity_ids=["string"],
    slug="string",
    sub_status_ids=["string"],
    trigger_params={
        "pulse_condition": "string",
        "pulse_condition_label": "string",
        "pulse_condition_label_use_regexp": False,
        "pulse_condition_payload": "string",
        "pulse_condition_payload_use_regexp": False,
        "pulse_condition_source": "string",
        "pulse_condition_source_use_regexp": False,
        "pulse_labels": ["string"],
        "pulse_payloads": ["string"],
        "pulse_query_payload": "string",
        "pulse_sources": ["string"],
        "trigger_type": "string",
        "triggers": ["string"],
    },
    wait="string",
    workflow_group_id="string")

    const workflowPulseResource = new rootly.WorkflowPulse("workflowPulseResource", {
    causeIds: ["string"],
    command: "string",
    commandFeedbackEnabled: false,
    continuouslyRepeat: false,
    description: "string",
    enabled: false,
    environmentIds: ["string"],
    functionalityIds: ["string"],
    groupIds: ["string"],
    incidentRoleIds: ["string"],
    incidentTypeIds: ["string"],
    locked: false,
    name: "string",
    position: 0,
    repeatConditionDurationSinceFirstRun: "string",
    repeatConditionNumberOfRepeats: 0,
    repeatEveryDuration: "string",
    repeatOns: ["string"],
    serviceIds: ["string"],
    severityIds: ["string"],
    slug: "string",
    subStatusIds: ["string"],
    triggerParams: {
        pulseCondition: "string",
        pulseConditionLabel: "string",
        pulseConditionLabelUseRegexp: false,
        pulseConditionPayload: "string",
        pulseConditionPayloadUseRegexp: false,
        pulseConditionSource: "string",
        pulseConditionSourceUseRegexp: false,
        pulseLabels: ["string"],
        pulsePayloads: ["string"],
        pulseQueryPayload: "string",
        pulseSources: ["string"],
        triggerType: "string",
        triggers: ["string"],
    },
    wait: "string",
    workflowGroupId: "string",
});

    type: rootly:WorkflowPulse
properties:
    causeIds:
        - string
    command: string
    commandFeedbackEnabled: false
    continuouslyRepeat: false
    description: string
    enabled: false
    environmentIds:
        - string
    functionalityIds:
        - string
    groupIds:
        - string
    incidentRoleIds:
        - string
    incidentTypeIds:
        - string
    locked: false
    name: string
    position: 0
    repeatConditionDurationSinceFirstRun: string
    repeatConditionNumberOfRepeats: 0
    repeatEveryDuration: string
    repeatOns:
        - string
    serviceIds:
        - string
    severityIds:
        - string
    slug: string
    subStatusIds:
        - string
    triggerParams:
        pulseCondition: string
        pulseConditionLabel: string
        pulseConditionLabelUseRegexp: false
        pulseConditionPayload: string
        pulseConditionPayloadUseRegexp: false
        pulseConditionSource: string
        pulseConditionSourceUseRegexp: false
        pulseLabels:
            - string
        pulsePayloads:
            - string
        pulseQueryPayload: string
        pulseSources:
            - string
        triggerType: string
        triggers:
            - string
    wait: string
    workflowGroupId: string

    WorkflowPulse Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The WorkflowPulse resource accepts the following input properties:

    CauseIds List<string>
    Command string
    Workflow command
    CommandFeedbackEnabled bool
    This will notify you back when the workflow is starting. Value must be one of true or false
    ContinuouslyRepeat bool
    When continuously repeat is true, repeat workflows aren't automatically stopped when conditions aren't met. This setting won't override your conditions set by repeatconditiondurationsincefirstrun and repeatconditionnumberof_repeats parameters.. Value must be one of true or false
    Description string
    The description of the workflow
    Enabled bool
    EnvironmentIds List<string>
    FunctionalityIds List<string>
    GroupIds List<string>
    IncidentRoleIds List<string>
    IncidentTypeIds List<string>
    Locked bool
    Restricts workflow edits to admins when turned on. Only admins can set this field.. Value must be one of true or false
    Name string
    The title of the workflow
    Position int
    The order which the workflow should run with other workflows.
    RepeatConditionDurationSinceFirstRun string
    The workflow will stop repeating if its runtime since it's first workflow run exceeds the duration set in this field
    RepeatConditionNumberOfRepeats int
    The workflow will stop repeating if the number of repeats exceeds the value set in this field
    RepeatEveryDuration string
    Repeat workflow every duration
    RepeatOns List<string>
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    ServiceIds List<string>
    SeverityIds List<string>
    Slug string
    The slug of the workflow
    SubStatusIds List<string>
    TriggerParams WorkflowPulseTriggerParams
    Wait string
    Wait this duration before executing
    WorkflowGroupId string
    The group this workflow belongs to.
    CauseIds []string
    Command string
    Workflow command
    CommandFeedbackEnabled bool
    This will notify you back when the workflow is starting. Value must be one of true or false
    ContinuouslyRepeat bool
    When continuously repeat is true, repeat workflows aren't automatically stopped when conditions aren't met. This setting won't override your conditions set by repeatconditiondurationsincefirstrun and repeatconditionnumberof_repeats parameters.. Value must be one of true or false
    Description string
    The description of the workflow
    Enabled bool
    EnvironmentIds []string
    FunctionalityIds []string
    GroupIds []string
    IncidentRoleIds []string
    IncidentTypeIds []string
    Locked bool
    Restricts workflow edits to admins when turned on. Only admins can set this field.. Value must be one of true or false
    Name string
    The title of the workflow
    Position int
    The order which the workflow should run with other workflows.
    RepeatConditionDurationSinceFirstRun string
    The workflow will stop repeating if its runtime since it's first workflow run exceeds the duration set in this field
    RepeatConditionNumberOfRepeats int
    The workflow will stop repeating if the number of repeats exceeds the value set in this field
    RepeatEveryDuration string
    Repeat workflow every duration
    RepeatOns []string
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    ServiceIds []string
    SeverityIds []string
    Slug string
    The slug of the workflow
    SubStatusIds []string
    TriggerParams WorkflowPulseTriggerParamsArgs
    Wait string
    Wait this duration before executing
    WorkflowGroupId string
    The group this workflow belongs to.
    causeIds List<String>
    command String
    Workflow command
    commandFeedbackEnabled Boolean
    This will notify you back when the workflow is starting. Value must be one of true or false
    continuouslyRepeat Boolean
    When continuously repeat is true, repeat workflows aren't automatically stopped when conditions aren't met. This setting won't override your conditions set by repeatconditiondurationsincefirstrun and repeatconditionnumberof_repeats parameters.. Value must be one of true or false
    description String
    The description of the workflow
    enabled Boolean
    environmentIds List<String>
    functionalityIds List<String>
    groupIds List<String>
    incidentRoleIds List<String>
    incidentTypeIds List<String>
    locked Boolean
    Restricts workflow edits to admins when turned on. Only admins can set this field.. Value must be one of true or false
    name String
    The title of the workflow
    position Integer
    The order which the workflow should run with other workflows.
    repeatConditionDurationSinceFirstRun String
    The workflow will stop repeating if its runtime since it's first workflow run exceeds the duration set in this field
    repeatConditionNumberOfRepeats Integer
    The workflow will stop repeating if the number of repeats exceeds the value set in this field
    repeatEveryDuration String
    Repeat workflow every duration
    repeatOns List<String>
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    serviceIds List<String>
    severityIds List<String>
    slug String
    The slug of the workflow
    subStatusIds List<String>
    triggerParams WorkflowPulseTriggerParams
    wait_ String
    Wait this duration before executing
    workflowGroupId String
    The group this workflow belongs to.
    causeIds string[]
    command string
    Workflow command
    commandFeedbackEnabled boolean
    This will notify you back when the workflow is starting. Value must be one of true or false
    continuouslyRepeat boolean
    When continuously repeat is true, repeat workflows aren't automatically stopped when conditions aren't met. This setting won't override your conditions set by repeatconditiondurationsincefirstrun and repeatconditionnumberof_repeats parameters.. Value must be one of true or false
    description string
    The description of the workflow
    enabled boolean
    environmentIds string[]
    functionalityIds string[]
    groupIds string[]
    incidentRoleIds string[]
    incidentTypeIds string[]
    locked boolean
    Restricts workflow edits to admins when turned on. Only admins can set this field.. Value must be one of true or false
    name string
    The title of the workflow
    position number
    The order which the workflow should run with other workflows.
    repeatConditionDurationSinceFirstRun string
    The workflow will stop repeating if its runtime since it's first workflow run exceeds the duration set in this field
    repeatConditionNumberOfRepeats number
    The workflow will stop repeating if the number of repeats exceeds the value set in this field
    repeatEveryDuration string
    Repeat workflow every duration
    repeatOns string[]
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    serviceIds string[]
    severityIds string[]
    slug string
    The slug of the workflow
    subStatusIds string[]
    triggerParams WorkflowPulseTriggerParams
    wait string
    Wait this duration before executing
    workflowGroupId string
    The group this workflow belongs to.
    cause_ids Sequence[str]
    command str
    Workflow command
    command_feedback_enabled bool
    This will notify you back when the workflow is starting. Value must be one of true or false
    continuously_repeat bool
    When continuously repeat is true, repeat workflows aren't automatically stopped when conditions aren't met. This setting won't override your conditions set by repeatconditiondurationsincefirstrun and repeatconditionnumberof_repeats parameters.. Value must be one of true or false
    description str
    The description of the workflow
    enabled bool
    environment_ids Sequence[str]
    functionality_ids Sequence[str]
    group_ids Sequence[str]
    incident_role_ids Sequence[str]
    incident_type_ids Sequence[str]
    locked bool
    Restricts workflow edits to admins when turned on. Only admins can set this field.. Value must be one of true or false
    name str
    The title of the workflow
    position int
    The order which the workflow should run with other workflows.
    repeat_condition_duration_since_first_run str
    The workflow will stop repeating if its runtime since it's first workflow run exceeds the duration set in this field
    repeat_condition_number_of_repeats int
    The workflow will stop repeating if the number of repeats exceeds the value set in this field
    repeat_every_duration str
    Repeat workflow every duration
    repeat_ons Sequence[str]
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    service_ids Sequence[str]
    severity_ids Sequence[str]
    slug str
    The slug of the workflow
    sub_status_ids Sequence[str]
    trigger_params WorkflowPulseTriggerParamsArgs
    wait str
    Wait this duration before executing
    workflow_group_id str
    The group this workflow belongs to.
    causeIds List<String>
    command String
    Workflow command
    commandFeedbackEnabled Boolean
    This will notify you back when the workflow is starting. Value must be one of true or false
    continuouslyRepeat Boolean
    When continuously repeat is true, repeat workflows aren't automatically stopped when conditions aren't met. This setting won't override your conditions set by repeatconditiondurationsincefirstrun and repeatconditionnumberof_repeats parameters.. Value must be one of true or false
    description String
    The description of the workflow
    enabled Boolean
    environmentIds List<String>
    functionalityIds List<String>
    groupIds List<String>
    incidentRoleIds List<String>
    incidentTypeIds List<String>
    locked Boolean
    Restricts workflow edits to admins when turned on. Only admins can set this field.. Value must be one of true or false
    name String
    The title of the workflow
    position Number
    The order which the workflow should run with other workflows.
    repeatConditionDurationSinceFirstRun String
    The workflow will stop repeating if its runtime since it's first workflow run exceeds the duration set in this field
    repeatConditionNumberOfRepeats Number
    The workflow will stop repeating if the number of repeats exceeds the value set in this field
    repeatEveryDuration String
    Repeat workflow every duration
    repeatOns List<String>
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    serviceIds List<String>
    severityIds List<String>
    slug String
    The slug of the workflow
    subStatusIds List<String>
    triggerParams Property Map
    wait String
    Wait this duration before executing
    workflowGroupId String
    The group this workflow belongs to.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WorkflowPulse resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing WorkflowPulse Resource

    Get an existing WorkflowPulse resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: WorkflowPulseState, opts?: CustomResourceOptions): WorkflowPulse
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cause_ids: Optional[Sequence[str]] = None,
        command: Optional[str] = None,
        command_feedback_enabled: Optional[bool] = None,
        continuously_repeat: Optional[bool] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        environment_ids: Optional[Sequence[str]] = None,
        functionality_ids: Optional[Sequence[str]] = None,
        group_ids: Optional[Sequence[str]] = None,
        incident_role_ids: Optional[Sequence[str]] = None,
        incident_type_ids: Optional[Sequence[str]] = None,
        locked: Optional[bool] = None,
        name: Optional[str] = None,
        position: Optional[int] = None,
        repeat_condition_duration_since_first_run: Optional[str] = None,
        repeat_condition_number_of_repeats: Optional[int] = None,
        repeat_every_duration: Optional[str] = None,
        repeat_ons: Optional[Sequence[str]] = None,
        service_ids: Optional[Sequence[str]] = None,
        severity_ids: Optional[Sequence[str]] = None,
        slug: Optional[str] = None,
        sub_status_ids: Optional[Sequence[str]] = None,
        trigger_params: Optional[WorkflowPulseTriggerParamsArgs] = None,
        wait: Optional[str] = None,
        workflow_group_id: Optional[str] = None) -> WorkflowPulse
    func GetWorkflowPulse(ctx *Context, name string, id IDInput, state *WorkflowPulseState, opts ...ResourceOption) (*WorkflowPulse, error)
    public static WorkflowPulse Get(string name, Input<string> id, WorkflowPulseState? state, CustomResourceOptions? opts = null)
    public static WorkflowPulse get(String name, Output<String> id, WorkflowPulseState state, CustomResourceOptions options)
    resources:  _:    type: rootly:WorkflowPulse    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CauseIds List<string>
    Command string
    Workflow command
    CommandFeedbackEnabled bool
    This will notify you back when the workflow is starting. Value must be one of true or false
    ContinuouslyRepeat bool
    When continuously repeat is true, repeat workflows aren't automatically stopped when conditions aren't met. This setting won't override your conditions set by repeatconditiondurationsincefirstrun and repeatconditionnumberof_repeats parameters.. Value must be one of true or false
    Description string
    The description of the workflow
    Enabled bool
    EnvironmentIds List<string>
    FunctionalityIds List<string>
    GroupIds List<string>
    IncidentRoleIds List<string>
    IncidentTypeIds List<string>
    Locked bool
    Restricts workflow edits to admins when turned on. Only admins can set this field.. Value must be one of true or false
    Name string
    The title of the workflow
    Position int
    The order which the workflow should run with other workflows.
    RepeatConditionDurationSinceFirstRun string
    The workflow will stop repeating if its runtime since it's first workflow run exceeds the duration set in this field
    RepeatConditionNumberOfRepeats int
    The workflow will stop repeating if the number of repeats exceeds the value set in this field
    RepeatEveryDuration string
    Repeat workflow every duration
    RepeatOns List<string>
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    ServiceIds List<string>
    SeverityIds List<string>
    Slug string
    The slug of the workflow
    SubStatusIds List<string>
    TriggerParams WorkflowPulseTriggerParams
    Wait string
    Wait this duration before executing
    WorkflowGroupId string
    The group this workflow belongs to.
    CauseIds []string
    Command string
    Workflow command
    CommandFeedbackEnabled bool
    This will notify you back when the workflow is starting. Value must be one of true or false
    ContinuouslyRepeat bool
    When continuously repeat is true, repeat workflows aren't automatically stopped when conditions aren't met. This setting won't override your conditions set by repeatconditiondurationsincefirstrun and repeatconditionnumberof_repeats parameters.. Value must be one of true or false
    Description string
    The description of the workflow
    Enabled bool
    EnvironmentIds []string
    FunctionalityIds []string
    GroupIds []string
    IncidentRoleIds []string
    IncidentTypeIds []string
    Locked bool
    Restricts workflow edits to admins when turned on. Only admins can set this field.. Value must be one of true or false
    Name string
    The title of the workflow
    Position int
    The order which the workflow should run with other workflows.
    RepeatConditionDurationSinceFirstRun string
    The workflow will stop repeating if its runtime since it's first workflow run exceeds the duration set in this field
    RepeatConditionNumberOfRepeats int
    The workflow will stop repeating if the number of repeats exceeds the value set in this field
    RepeatEveryDuration string
    Repeat workflow every duration
    RepeatOns []string
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    ServiceIds []string
    SeverityIds []string
    Slug string
    The slug of the workflow
    SubStatusIds []string
    TriggerParams WorkflowPulseTriggerParamsArgs
    Wait string
    Wait this duration before executing
    WorkflowGroupId string
    The group this workflow belongs to.
    causeIds List<String>
    command String
    Workflow command
    commandFeedbackEnabled Boolean
    This will notify you back when the workflow is starting. Value must be one of true or false
    continuouslyRepeat Boolean
    When continuously repeat is true, repeat workflows aren't automatically stopped when conditions aren't met. This setting won't override your conditions set by repeatconditiondurationsincefirstrun and repeatconditionnumberof_repeats parameters.. Value must be one of true or false
    description String
    The description of the workflow
    enabled Boolean
    environmentIds List<String>
    functionalityIds List<String>
    groupIds List<String>
    incidentRoleIds List<String>
    incidentTypeIds List<String>
    locked Boolean
    Restricts workflow edits to admins when turned on. Only admins can set this field.. Value must be one of true or false
    name String
    The title of the workflow
    position Integer
    The order which the workflow should run with other workflows.
    repeatConditionDurationSinceFirstRun String
    The workflow will stop repeating if its runtime since it's first workflow run exceeds the duration set in this field
    repeatConditionNumberOfRepeats Integer
    The workflow will stop repeating if the number of repeats exceeds the value set in this field
    repeatEveryDuration String
    Repeat workflow every duration
    repeatOns List<String>
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    serviceIds List<String>
    severityIds List<String>
    slug String
    The slug of the workflow
    subStatusIds List<String>
    triggerParams WorkflowPulseTriggerParams
    wait_ String
    Wait this duration before executing
    workflowGroupId String
    The group this workflow belongs to.
    causeIds string[]
    command string
    Workflow command
    commandFeedbackEnabled boolean
    This will notify you back when the workflow is starting. Value must be one of true or false
    continuouslyRepeat boolean
    When continuously repeat is true, repeat workflows aren't automatically stopped when conditions aren't met. This setting won't override your conditions set by repeatconditiondurationsincefirstrun and repeatconditionnumberof_repeats parameters.. Value must be one of true or false
    description string
    The description of the workflow
    enabled boolean
    environmentIds string[]
    functionalityIds string[]
    groupIds string[]
    incidentRoleIds string[]
    incidentTypeIds string[]
    locked boolean
    Restricts workflow edits to admins when turned on. Only admins can set this field.. Value must be one of true or false
    name string
    The title of the workflow
    position number
    The order which the workflow should run with other workflows.
    repeatConditionDurationSinceFirstRun string
    The workflow will stop repeating if its runtime since it's first workflow run exceeds the duration set in this field
    repeatConditionNumberOfRepeats number
    The workflow will stop repeating if the number of repeats exceeds the value set in this field
    repeatEveryDuration string
    Repeat workflow every duration
    repeatOns string[]
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    serviceIds string[]
    severityIds string[]
    slug string
    The slug of the workflow
    subStatusIds string[]
    triggerParams WorkflowPulseTriggerParams
    wait string
    Wait this duration before executing
    workflowGroupId string
    The group this workflow belongs to.
    cause_ids Sequence[str]
    command str
    Workflow command
    command_feedback_enabled bool
    This will notify you back when the workflow is starting. Value must be one of true or false
    continuously_repeat bool
    When continuously repeat is true, repeat workflows aren't automatically stopped when conditions aren't met. This setting won't override your conditions set by repeatconditiondurationsincefirstrun and repeatconditionnumberof_repeats parameters.. Value must be one of true or false
    description str
    The description of the workflow
    enabled bool
    environment_ids Sequence[str]
    functionality_ids Sequence[str]
    group_ids Sequence[str]
    incident_role_ids Sequence[str]
    incident_type_ids Sequence[str]
    locked bool
    Restricts workflow edits to admins when turned on. Only admins can set this field.. Value must be one of true or false
    name str
    The title of the workflow
    position int
    The order which the workflow should run with other workflows.
    repeat_condition_duration_since_first_run str
    The workflow will stop repeating if its runtime since it's first workflow run exceeds the duration set in this field
    repeat_condition_number_of_repeats int
    The workflow will stop repeating if the number of repeats exceeds the value set in this field
    repeat_every_duration str
    Repeat workflow every duration
    repeat_ons Sequence[str]
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    service_ids Sequence[str]
    severity_ids Sequence[str]
    slug str
    The slug of the workflow
    sub_status_ids Sequence[str]
    trigger_params WorkflowPulseTriggerParamsArgs
    wait str
    Wait this duration before executing
    workflow_group_id str
    The group this workflow belongs to.
    causeIds List<String>
    command String
    Workflow command
    commandFeedbackEnabled Boolean
    This will notify you back when the workflow is starting. Value must be one of true or false
    continuouslyRepeat Boolean
    When continuously repeat is true, repeat workflows aren't automatically stopped when conditions aren't met. This setting won't override your conditions set by repeatconditiondurationsincefirstrun and repeatconditionnumberof_repeats parameters.. Value must be one of true or false
    description String
    The description of the workflow
    enabled Boolean
    environmentIds List<String>
    functionalityIds List<String>
    groupIds List<String>
    incidentRoleIds List<String>
    incidentTypeIds List<String>
    locked Boolean
    Restricts workflow edits to admins when turned on. Only admins can set this field.. Value must be one of true or false
    name String
    The title of the workflow
    position Number
    The order which the workflow should run with other workflows.
    repeatConditionDurationSinceFirstRun String
    The workflow will stop repeating if its runtime since it's first workflow run exceeds the duration set in this field
    repeatConditionNumberOfRepeats Number
    The workflow will stop repeating if the number of repeats exceeds the value set in this field
    repeatEveryDuration String
    Repeat workflow every duration
    repeatOns List<String>
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    serviceIds List<String>
    severityIds List<String>
    slug String
    The slug of the workflow
    subStatusIds List<String>
    triggerParams Property Map
    wait String
    Wait this duration before executing
    workflowGroupId String
    The group this workflow belongs to.

    Supporting Types

    WorkflowPulseTriggerParams, WorkflowPulseTriggerParamsArgs

    PulseCondition string
    Value must be one of ALL, ANY, NONE.
    PulseConditionLabel string
    Value must be one of IS, IS NOT, ANY, CONTAINS, CONTAINS_ALL, CONTAINS_NONE, NONE, SET, UNSET.
    PulseConditionLabelUseRegexp bool
    Value must be one of true or false
    PulseConditionPayload string
    Value must be one of IS, IS NOT, ANY, CONTAINS, CONTAINS_ALL, CONTAINS_NONE, NONE, SET, UNSET.
    PulseConditionPayloadUseRegexp bool
    Value must be one of true or false
    PulseConditionSource string
    Value must be one of IS, IS NOT, ANY, CONTAINS, CONTAINS_ALL, CONTAINS_NONE, NONE, SET, UNSET.
    PulseConditionSourceUseRegexp bool
    Value must be one of true or false
    PulseLabels List<string>
    PulsePayloads List<string>
    PulseQueryPayload string
    You can use jsonpath syntax. eg: $.incident.teams[*]
    PulseSources List<string>
    TriggerType string
    Value must be one of pulse.
    Triggers List<string>
    Actions that trigger the workflow. Value must be one of pulseCreated.
    PulseCondition string
    Value must be one of ALL, ANY, NONE.
    PulseConditionLabel string
    Value must be one of IS, IS NOT, ANY, CONTAINS, CONTAINS_ALL, CONTAINS_NONE, NONE, SET, UNSET.
    PulseConditionLabelUseRegexp bool
    Value must be one of true or false
    PulseConditionPayload string
    Value must be one of IS, IS NOT, ANY, CONTAINS, CONTAINS_ALL, CONTAINS_NONE, NONE, SET, UNSET.
    PulseConditionPayloadUseRegexp bool
    Value must be one of true or false
    PulseConditionSource string
    Value must be one of IS, IS NOT, ANY, CONTAINS, CONTAINS_ALL, CONTAINS_NONE, NONE, SET, UNSET.
    PulseConditionSourceUseRegexp bool
    Value must be one of true or false
    PulseLabels []string
    PulsePayloads []string
    PulseQueryPayload string
    You can use jsonpath syntax. eg: $.incident.teams[*]
    PulseSources []string
    TriggerType string
    Value must be one of pulse.
    Triggers []string
    Actions that trigger the workflow. Value must be one of pulseCreated.
    pulseCondition String
    Value must be one of ALL, ANY, NONE.
    pulseConditionLabel String
    Value must be one of IS, IS NOT, ANY, CONTAINS, CONTAINS_ALL, CONTAINS_NONE, NONE, SET, UNSET.
    pulseConditionLabelUseRegexp Boolean
    Value must be one of true or false
    pulseConditionPayload String
    Value must be one of IS, IS NOT, ANY, CONTAINS, CONTAINS_ALL, CONTAINS_NONE, NONE, SET, UNSET.
    pulseConditionPayloadUseRegexp Boolean
    Value must be one of true or false
    pulseConditionSource String
    Value must be one of IS, IS NOT, ANY, CONTAINS, CONTAINS_ALL, CONTAINS_NONE, NONE, SET, UNSET.
    pulseConditionSourceUseRegexp Boolean
    Value must be one of true or false
    pulseLabels List<String>
    pulsePayloads List<String>
    pulseQueryPayload String
    You can use jsonpath syntax. eg: $.incident.teams[*]
    pulseSources List<String>
    triggerType String
    Value must be one of pulse.
    triggers List<String>
    Actions that trigger the workflow. Value must be one of pulseCreated.
    pulseCondition string
    Value must be one of ALL, ANY, NONE.
    pulseConditionLabel string
    Value must be one of IS, IS NOT, ANY, CONTAINS, CONTAINS_ALL, CONTAINS_NONE, NONE, SET, UNSET.
    pulseConditionLabelUseRegexp boolean
    Value must be one of true or false
    pulseConditionPayload string
    Value must be one of IS, IS NOT, ANY, CONTAINS, CONTAINS_ALL, CONTAINS_NONE, NONE, SET, UNSET.
    pulseConditionPayloadUseRegexp boolean
    Value must be one of true or false
    pulseConditionSource string
    Value must be one of IS, IS NOT, ANY, CONTAINS, CONTAINS_ALL, CONTAINS_NONE, NONE, SET, UNSET.
    pulseConditionSourceUseRegexp boolean
    Value must be one of true or false
    pulseLabels string[]
    pulsePayloads string[]
    pulseQueryPayload string
    You can use jsonpath syntax. eg: $.incident.teams[*]
    pulseSources string[]
    triggerType string
    Value must be one of pulse.
    triggers string[]
    Actions that trigger the workflow. Value must be one of pulseCreated.
    pulse_condition str
    Value must be one of ALL, ANY, NONE.
    pulse_condition_label str
    Value must be one of IS, IS NOT, ANY, CONTAINS, CONTAINS_ALL, CONTAINS_NONE, NONE, SET, UNSET.
    pulse_condition_label_use_regexp bool
    Value must be one of true or false
    pulse_condition_payload str
    Value must be one of IS, IS NOT, ANY, CONTAINS, CONTAINS_ALL, CONTAINS_NONE, NONE, SET, UNSET.
    pulse_condition_payload_use_regexp bool
    Value must be one of true or false
    pulse_condition_source str
    Value must be one of IS, IS NOT, ANY, CONTAINS, CONTAINS_ALL, CONTAINS_NONE, NONE, SET, UNSET.
    pulse_condition_source_use_regexp bool
    Value must be one of true or false
    pulse_labels Sequence[str]
    pulse_payloads Sequence[str]
    pulse_query_payload str
    You can use jsonpath syntax. eg: $.incident.teams[*]
    pulse_sources Sequence[str]
    trigger_type str
    Value must be one of pulse.
    triggers Sequence[str]
    Actions that trigger the workflow. Value must be one of pulseCreated.
    pulseCondition String
    Value must be one of ALL, ANY, NONE.
    pulseConditionLabel String
    Value must be one of IS, IS NOT, ANY, CONTAINS, CONTAINS_ALL, CONTAINS_NONE, NONE, SET, UNSET.
    pulseConditionLabelUseRegexp Boolean
    Value must be one of true or false
    pulseConditionPayload String
    Value must be one of IS, IS NOT, ANY, CONTAINS, CONTAINS_ALL, CONTAINS_NONE, NONE, SET, UNSET.
    pulseConditionPayloadUseRegexp Boolean
    Value must be one of true or false
    pulseConditionSource String
    Value must be one of IS, IS NOT, ANY, CONTAINS, CONTAINS_ALL, CONTAINS_NONE, NONE, SET, UNSET.
    pulseConditionSourceUseRegexp Boolean
    Value must be one of true or false
    pulseLabels List<String>
    pulsePayloads List<String>
    pulseQueryPayload String
    You can use jsonpath syntax. eg: $.incident.teams[*]
    pulseSources List<String>
    triggerType String
    Value must be one of pulse.
    triggers List<String>
    Actions that trigger the workflow. Value must be one of pulseCreated.

    Import

    rootly.WorkflowPulse can be imported using the import command.

    $ pulumi import rootly:index/workflowPulse:WorkflowPulse primary a816421c-6ceb-481a-87c4-585e47451f24

    Or using an import block.

    Locate the resource id in the web app, or retrieve it by listing resources through the API if it’s not visible in the web app.

    HCL can be generated from the import block using the -generate-config-out flag.

    pulumi preview -generate-config-out=generated.tf

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    rootly rootlyhq/pulumi-rootly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rootly Terraform Provider.
    rootly logo
    Viewing docs for Rootly v3.3.0
    published on Thursday, May 7, 2026 by rootlyhq
    Schema (JSON)
    rootlyhq/pulumi-rootly
      Try Pulumi Cloud free. Your team will thank you.