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

rootly.WorkflowTaskSendSms

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

    Manages workflow sendSms task.

    Example Usage

    resource "rootly_workflow_incident" "send_sms" {
  name        = "Send SMS to a teammate"
  description = "Automatically send SMS to a specific teammate."
  trigger_params {
    triggers                  = ["incident_created"]
    incident_statuses         = ["started"]
    incident_condition_status = "IS"
  }
  enabled = true
}

resource "rootly_workflow_task_send_sms" "send_sms" {
  workflow_id     = rootly_workflow_incident.send_sms.id
  skip_on_failure = false
  enabled         = true
  task_params {
    name          = "Send SMS"
    content       = "We have an ongoing incident {{ incident.title }} of severity {{ incident.severity }} and your assistance is required."
    phone_numbers = ["+11231231231", "+11231231232"]
  }
}

    Create WorkflowTaskSendSms Resource

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

    Constructor syntax

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

@overload
def WorkflowTaskSendSms(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        task_params: Optional[WorkflowTaskSendSmsTaskParamsArgs] = None,
                        workflow_id: Optional[str] = None,
                        enabled: Optional[bool] = None,
                        name: Optional[str] = None,
                        position: Optional[int] = None,
                        skip_on_failure: Optional[bool] = None)
    func NewWorkflowTaskSendSms(ctx *Context, name string, args WorkflowTaskSendSmsArgs, opts ...ResourceOption) (*WorkflowTaskSendSms, error)
    public WorkflowTaskSendSms(string name, WorkflowTaskSendSmsArgs args, CustomResourceOptions? opts = null)
    public WorkflowTaskSendSms(String name, WorkflowTaskSendSmsArgs args)
public WorkflowTaskSendSms(String name, WorkflowTaskSendSmsArgs args, CustomResourceOptions options)

    type: rootly:WorkflowTaskSendSms
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 WorkflowTaskSendSmsArgs
    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 WorkflowTaskSendSmsArgs
    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 WorkflowTaskSendSmsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowTaskSendSmsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowTaskSendSmsArgs
    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 workflowTaskSendSmsResource = new Rootly.WorkflowTaskSendSms("workflowTaskSendSmsResource", new()
{
    TaskParams = new Rootly.Inputs.WorkflowTaskSendSmsTaskParamsArgs
    {
        Content = "string",
        Name = "string",
        PhoneNumbers = new[]
        {
            "string",
        },
        TaskType = "string",
    },
    WorkflowId = "string",
    Enabled = false,
    Name = "string",
    Position = 0,
    SkipOnFailure = false,
});

    example, err := rootly.NewWorkflowTaskSendSms(ctx, "workflowTaskSendSmsResource", &rootly.WorkflowTaskSendSmsArgs{
	TaskParams: &rootly.WorkflowTaskSendSmsTaskParamsArgs{
		Content: pulumi.String("string"),
		Name:    pulumi.String("string"),
		PhoneNumbers: pulumi.StringArray{
			pulumi.String("string"),
		},
		TaskType: pulumi.String("string"),
	},
	WorkflowId:    pulumi.String("string"),
	Enabled:       pulumi.Bool(false),
	Name:          pulumi.String("string"),
	Position:      pulumi.Int(0),
	SkipOnFailure: pulumi.Bool(false),
})

    var workflowTaskSendSmsResource = new WorkflowTaskSendSms("workflowTaskSendSmsResource", WorkflowTaskSendSmsArgs.builder()
    .taskParams(WorkflowTaskSendSmsTaskParamsArgs.builder()
        .content("string")
        .name("string")
        .phoneNumbers("string")
        .taskType("string")
        .build())
    .workflowId("string")
    .enabled(false)
    .name("string")
    .position(0)
    .skipOnFailure(false)
    .build());

    workflow_task_send_sms_resource = rootly.WorkflowTaskSendSms("workflowTaskSendSmsResource",
    task_params={
        "content": "string",
        "name": "string",
        "phone_numbers": ["string"],
        "task_type": "string",
    },
    workflow_id="string",
    enabled=False,
    name="string",
    position=0,
    skip_on_failure=False)

    const workflowTaskSendSmsResource = new rootly.WorkflowTaskSendSms("workflowTaskSendSmsResource", {
    taskParams: {
        content: "string",
        name: "string",
        phoneNumbers: ["string"],
        taskType: "string",
    },
    workflowId: "string",
    enabled: false,
    name: "string",
    position: 0,
    skipOnFailure: false,
});

    type: rootly:WorkflowTaskSendSms
properties:
    enabled: false
    name: string
    position: 0
    skipOnFailure: false
    taskParams:
        content: string
        name: string
        phoneNumbers:
            - string
        taskType: string
    workflowId: string

    WorkflowTaskSendSms 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 WorkflowTaskSendSms resource accepts the following input properties:

    TaskParams WorkflowTaskSendSmsTaskParams
    The parameters for this workflow task.
    WorkflowId string
    The ID of the parent workflow
    Enabled bool
    Enable/disable this workflow task
    Name string
    Name of the workflow task
    Position int
    The position of the workflow task (1 being top of list)
    SkipOnFailure bool
    Skip workflow task if any failures
    TaskParams WorkflowTaskSendSmsTaskParamsArgs
    The parameters for this workflow task.
    WorkflowId string
    The ID of the parent workflow
    Enabled bool
    Enable/disable this workflow task
    Name string
    Name of the workflow task
    Position int
    The position of the workflow task (1 being top of list)
    SkipOnFailure bool
    Skip workflow task if any failures
    taskParams WorkflowTaskSendSmsTaskParams
    The parameters for this workflow task.
    workflowId String
    The ID of the parent workflow
    enabled Boolean
    Enable/disable this workflow task
    name String
    Name of the workflow task
    position Integer
    The position of the workflow task (1 being top of list)
    skipOnFailure Boolean
    Skip workflow task if any failures
    taskParams WorkflowTaskSendSmsTaskParams
    The parameters for this workflow task.
    workflowId string
    The ID of the parent workflow
    enabled boolean
    Enable/disable this workflow task
    name string
    Name of the workflow task
    position number
    The position of the workflow task (1 being top of list)
    skipOnFailure boolean
    Skip workflow task if any failures
    task_params WorkflowTaskSendSmsTaskParamsArgs
    The parameters for this workflow task.
    workflow_id str
    The ID of the parent workflow
    enabled bool
    Enable/disable this workflow task
    name str
    Name of the workflow task
    position int
    The position of the workflow task (1 being top of list)
    skip_on_failure bool
    Skip workflow task if any failures
    taskParams Property Map
    The parameters for this workflow task.
    workflowId String
    The ID of the parent workflow
    enabled Boolean
    Enable/disable this workflow task
    name String
    Name of the workflow task
    position Number
    The position of the workflow task (1 being top of list)
    skipOnFailure Boolean
    Skip workflow task if any failures

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WorkflowTaskSendSms 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 WorkflowTaskSendSms Resource

    Get an existing WorkflowTaskSendSms 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?: WorkflowTaskSendSmsState, opts?: CustomResourceOptions): WorkflowTaskSendSms
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        name: Optional[str] = None,
        position: Optional[int] = None,
        skip_on_failure: Optional[bool] = None,
        task_params: Optional[WorkflowTaskSendSmsTaskParamsArgs] = None,
        workflow_id: Optional[str] = None) -> WorkflowTaskSendSms
    func GetWorkflowTaskSendSms(ctx *Context, name string, id IDInput, state *WorkflowTaskSendSmsState, opts ...ResourceOption) (*WorkflowTaskSendSms, error)
    public static WorkflowTaskSendSms Get(string name, Input<string> id, WorkflowTaskSendSmsState? state, CustomResourceOptions? opts = null)
    public static WorkflowTaskSendSms get(String name, Output<String> id, WorkflowTaskSendSmsState state, CustomResourceOptions options)
    resources:  _:    type: rootly:WorkflowTaskSendSms    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:
    Enabled bool
    Enable/disable this workflow task
    Name string
    Name of the workflow task
    Position int
    The position of the workflow task (1 being top of list)
    SkipOnFailure bool
    Skip workflow task if any failures
    TaskParams WorkflowTaskSendSmsTaskParams
    The parameters for this workflow task.
    WorkflowId string
    The ID of the parent workflow
    Enabled bool
    Enable/disable this workflow task
    Name string
    Name of the workflow task
    Position int
    The position of the workflow task (1 being top of list)
    SkipOnFailure bool
    Skip workflow task if any failures
    TaskParams WorkflowTaskSendSmsTaskParamsArgs
    The parameters for this workflow task.
    WorkflowId string
    The ID of the parent workflow
    enabled Boolean
    Enable/disable this workflow task
    name String
    Name of the workflow task
    position Integer
    The position of the workflow task (1 being top of list)
    skipOnFailure Boolean
    Skip workflow task if any failures
    taskParams WorkflowTaskSendSmsTaskParams
    The parameters for this workflow task.
    workflowId String
    The ID of the parent workflow
    enabled boolean
    Enable/disable this workflow task
    name string
    Name of the workflow task
    position number
    The position of the workflow task (1 being top of list)
    skipOnFailure boolean
    Skip workflow task if any failures
    taskParams WorkflowTaskSendSmsTaskParams
    The parameters for this workflow task.
    workflowId string
    The ID of the parent workflow
    enabled bool
    Enable/disable this workflow task
    name str
    Name of the workflow task
    position int
    The position of the workflow task (1 being top of list)
    skip_on_failure bool
    Skip workflow task if any failures
    task_params WorkflowTaskSendSmsTaskParamsArgs
    The parameters for this workflow task.
    workflow_id str
    The ID of the parent workflow
    enabled Boolean
    Enable/disable this workflow task
    name String
    Name of the workflow task
    position Number
    The position of the workflow task (1 being top of list)
    skipOnFailure Boolean
    Skip workflow task if any failures
    taskParams Property Map
    The parameters for this workflow task.
    workflowId String
    The ID of the parent workflow

    Supporting Types

    WorkflowTaskSendSmsTaskParams, WorkflowTaskSendSmsTaskParamsArgs

    Content string
    The SMS message
    Name string
    The name
    PhoneNumbers List<string>
    TaskType string
    Content string
    The SMS message
    Name string
    The name
    PhoneNumbers []string
    TaskType string
    content String
    The SMS message
    name String
    The name
    phoneNumbers List<String>
    taskType String
    content string
    The SMS message
    name string
    The name
    phoneNumbers string[]
    taskType string
    content str
    The SMS message
    name str
    The name
    phone_numbers Sequence[str]
    task_type str
    content String
    The SMS message
    name String
    The name
    phoneNumbers List<String>
    taskType String

    Import

    rootly.WorkflowTaskSendSms can be imported using the import command.

    $ pulumi import rootly:index/workflowTaskSendSms:WorkflowTaskSendSms 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.