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

rootly.WorkflowTaskCreateOpenaiChatCompletion

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

    Manages workflow createOpenaiChatCompletion task.

    Create WorkflowTaskCreateOpenaiChatCompletion Resource

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

    Constructor syntax

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

@overload
def WorkflowTaskCreateOpenaiChatCompletion(resource_name: str,
                                           opts: Optional[ResourceOptions] = None,
                                           task_params: Optional[WorkflowTaskCreateOpenaiChatCompletionTaskParamsArgs] = 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 NewWorkflowTaskCreateOpenaiChatCompletion(ctx *Context, name string, args WorkflowTaskCreateOpenaiChatCompletionArgs, opts ...ResourceOption) (*WorkflowTaskCreateOpenaiChatCompletion, error)
    public WorkflowTaskCreateOpenaiChatCompletion(string name, WorkflowTaskCreateOpenaiChatCompletionArgs args, CustomResourceOptions? opts = null)
    public WorkflowTaskCreateOpenaiChatCompletion(String name, WorkflowTaskCreateOpenaiChatCompletionArgs args)
public WorkflowTaskCreateOpenaiChatCompletion(String name, WorkflowTaskCreateOpenaiChatCompletionArgs args, CustomResourceOptions options)

    type: rootly:WorkflowTaskCreateOpenaiChatCompletion
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 WorkflowTaskCreateOpenaiChatCompletionArgs
    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 WorkflowTaskCreateOpenaiChatCompletionArgs
    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 WorkflowTaskCreateOpenaiChatCompletionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowTaskCreateOpenaiChatCompletionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowTaskCreateOpenaiChatCompletionArgs
    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 workflowTaskCreateOpenaiChatCompletionResource = new Rootly.WorkflowTaskCreateOpenaiChatCompletion("workflowTaskCreateOpenaiChatCompletionResource", new()
{
    TaskParams = new Rootly.Inputs.WorkflowTaskCreateOpenaiChatCompletionTaskParamsArgs
    {
        Model = 
        {
            { "string", "string" },
        },
        Prompt = "string",
        MaxTokens = "string",
        ReasoningEffort = "string",
        ReasoningSummary = "string",
        SystemPrompt = "string",
        TaskType = "string",
        Temperature = 0,
        TopP = 0,
    },
    WorkflowId = "string",
    Enabled = false,
    Name = "string",
    Position = 0,
    SkipOnFailure = false,
});

    example, err := rootly.NewWorkflowTaskCreateOpenaiChatCompletion(ctx, "workflowTaskCreateOpenaiChatCompletionResource", &rootly.WorkflowTaskCreateOpenaiChatCompletionArgs{
	TaskParams: &rootly.WorkflowTaskCreateOpenaiChatCompletionTaskParamsArgs{
		Model: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		Prompt:           pulumi.String("string"),
		MaxTokens:        pulumi.String("string"),
		ReasoningEffort:  pulumi.String("string"),
		ReasoningSummary: pulumi.String("string"),
		SystemPrompt:     pulumi.String("string"),
		TaskType:         pulumi.String("string"),
		Temperature:      pulumi.Int(0),
		TopP:             pulumi.Int(0),
	},
	WorkflowId:    pulumi.String("string"),
	Enabled:       pulumi.Bool(false),
	Name:          pulumi.String("string"),
	Position:      pulumi.Int(0),
	SkipOnFailure: pulumi.Bool(false),
})

    var workflowTaskCreateOpenaiChatCompletionResource = new WorkflowTaskCreateOpenaiChatCompletion("workflowTaskCreateOpenaiChatCompletionResource", WorkflowTaskCreateOpenaiChatCompletionArgs.builder()
    .taskParams(WorkflowTaskCreateOpenaiChatCompletionTaskParamsArgs.builder()
        .model(Map.of("string", "string"))
        .prompt("string")
        .maxTokens("string")
        .reasoningEffort("string")
        .reasoningSummary("string")
        .systemPrompt("string")
        .taskType("string")
        .temperature(0)
        .topP(0)
        .build())
    .workflowId("string")
    .enabled(false)
    .name("string")
    .position(0)
    .skipOnFailure(false)
    .build());

    workflow_task_create_openai_chat_completion_resource = rootly.WorkflowTaskCreateOpenaiChatCompletion("workflowTaskCreateOpenaiChatCompletionResource",
    task_params={
        "model": {
            "string": "string",
        },
        "prompt": "string",
        "max_tokens": "string",
        "reasoning_effort": "string",
        "reasoning_summary": "string",
        "system_prompt": "string",
        "task_type": "string",
        "temperature": 0,
        "top_p": 0,
    },
    workflow_id="string",
    enabled=False,
    name="string",
    position=0,
    skip_on_failure=False)

    const workflowTaskCreateOpenaiChatCompletionResource = new rootly.WorkflowTaskCreateOpenaiChatCompletion("workflowTaskCreateOpenaiChatCompletionResource", {
    taskParams: {
        model: {
            string: "string",
        },
        prompt: "string",
        maxTokens: "string",
        reasoningEffort: "string",
        reasoningSummary: "string",
        systemPrompt: "string",
        taskType: "string",
        temperature: 0,
        topP: 0,
    },
    workflowId: "string",
    enabled: false,
    name: "string",
    position: 0,
    skipOnFailure: false,
});

    type: rootly:WorkflowTaskCreateOpenaiChatCompletion
properties:
    enabled: false
    name: string
    position: 0
    skipOnFailure: false
    taskParams:
        maxTokens: string
        model:
            string: string
        prompt: string
        reasoningEffort: string
        reasoningSummary: string
        systemPrompt: string
        taskType: string
        temperature: 0
        topP: 0
    workflowId: string

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

    TaskParams WorkflowTaskCreateOpenaiChatCompletionTaskParams
    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 WorkflowTaskCreateOpenaiChatCompletionTaskParamsArgs
    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 WorkflowTaskCreateOpenaiChatCompletionTaskParams
    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 WorkflowTaskCreateOpenaiChatCompletionTaskParams
    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 WorkflowTaskCreateOpenaiChatCompletionTaskParamsArgs
    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 WorkflowTaskCreateOpenaiChatCompletion 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 WorkflowTaskCreateOpenaiChatCompletion Resource

    Get an existing WorkflowTaskCreateOpenaiChatCompletion 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?: WorkflowTaskCreateOpenaiChatCompletionState, opts?: CustomResourceOptions): WorkflowTaskCreateOpenaiChatCompletion
    @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[WorkflowTaskCreateOpenaiChatCompletionTaskParamsArgs] = None,
        workflow_id: Optional[str] = None) -> WorkflowTaskCreateOpenaiChatCompletion
    func GetWorkflowTaskCreateOpenaiChatCompletion(ctx *Context, name string, id IDInput, state *WorkflowTaskCreateOpenaiChatCompletionState, opts ...ResourceOption) (*WorkflowTaskCreateOpenaiChatCompletion, error)
    public static WorkflowTaskCreateOpenaiChatCompletion Get(string name, Input<string> id, WorkflowTaskCreateOpenaiChatCompletionState? state, CustomResourceOptions? opts = null)
    public static WorkflowTaskCreateOpenaiChatCompletion get(String name, Output<String> id, WorkflowTaskCreateOpenaiChatCompletionState state, CustomResourceOptions options)
    resources:  _:    type: rootly:WorkflowTaskCreateOpenaiChatCompletion    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 WorkflowTaskCreateOpenaiChatCompletionTaskParams
    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 WorkflowTaskCreateOpenaiChatCompletionTaskParamsArgs
    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 WorkflowTaskCreateOpenaiChatCompletionTaskParams
    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 WorkflowTaskCreateOpenaiChatCompletionTaskParams
    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 WorkflowTaskCreateOpenaiChatCompletionTaskParamsArgs
    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

    WorkflowTaskCreateOpenaiChatCompletionTaskParams, WorkflowTaskCreateOpenaiChatCompletionTaskParamsArgs

    Model Dictionary<string, string>
    Map must contain two fields, id and name. The OpenAI model. eg: gpt-5-nano
    Prompt string
    The prompt to send to OpenAI
    MaxTokens string
    Maximum number of tokens to generate in the response
    ReasoningEffort string
    Constrains effort on reasoning for GPT-5 and o-series models. Value must be one of minimal, low, medium, high.
    ReasoningSummary string
    Summary of the reasoning performed by the model for GPT-5 and o-series models. Value must be one of auto, concise, detailed.
    SystemPrompt string
    The system prompt to send to OpenAI (optional)
    TaskType string
    Temperature int
    Controls randomness in the response. Higher values make output more random
    TopP int
    Controls diversity via nucleus sampling. Lower values make output more focused
    Model map[string]string
    Map must contain two fields, id and name. The OpenAI model. eg: gpt-5-nano
    Prompt string
    The prompt to send to OpenAI
    MaxTokens string
    Maximum number of tokens to generate in the response
    ReasoningEffort string
    Constrains effort on reasoning for GPT-5 and o-series models. Value must be one of minimal, low, medium, high.
    ReasoningSummary string
    Summary of the reasoning performed by the model for GPT-5 and o-series models. Value must be one of auto, concise, detailed.
    SystemPrompt string
    The system prompt to send to OpenAI (optional)
    TaskType string
    Temperature int
    Controls randomness in the response. Higher values make output more random
    TopP int
    Controls diversity via nucleus sampling. Lower values make output more focused
    model Map<String,String>
    Map must contain two fields, id and name. The OpenAI model. eg: gpt-5-nano
    prompt String
    The prompt to send to OpenAI
    maxTokens String
    Maximum number of tokens to generate in the response
    reasoningEffort String
    Constrains effort on reasoning for GPT-5 and o-series models. Value must be one of minimal, low, medium, high.
    reasoningSummary String
    Summary of the reasoning performed by the model for GPT-5 and o-series models. Value must be one of auto, concise, detailed.
    systemPrompt String
    The system prompt to send to OpenAI (optional)
    taskType String
    temperature Integer
    Controls randomness in the response. Higher values make output more random
    topP Integer
    Controls diversity via nucleus sampling. Lower values make output more focused
    model {[key: string]: string}
    Map must contain two fields, id and name. The OpenAI model. eg: gpt-5-nano
    prompt string
    The prompt to send to OpenAI
    maxTokens string
    Maximum number of tokens to generate in the response
    reasoningEffort string
    Constrains effort on reasoning for GPT-5 and o-series models. Value must be one of minimal, low, medium, high.
    reasoningSummary string
    Summary of the reasoning performed by the model for GPT-5 and o-series models. Value must be one of auto, concise, detailed.
    systemPrompt string
    The system prompt to send to OpenAI (optional)
    taskType string
    temperature number
    Controls randomness in the response. Higher values make output more random
    topP number
    Controls diversity via nucleus sampling. Lower values make output more focused
    model Mapping[str, str]
    Map must contain two fields, id and name. The OpenAI model. eg: gpt-5-nano
    prompt str
    The prompt to send to OpenAI
    max_tokens str
    Maximum number of tokens to generate in the response
    reasoning_effort str
    Constrains effort on reasoning for GPT-5 and o-series models. Value must be one of minimal, low, medium, high.
    reasoning_summary str
    Summary of the reasoning performed by the model for GPT-5 and o-series models. Value must be one of auto, concise, detailed.
    system_prompt str
    The system prompt to send to OpenAI (optional)
    task_type str
    temperature int
    Controls randomness in the response. Higher values make output more random
    top_p int
    Controls diversity via nucleus sampling. Lower values make output more focused
    model Map<String>
    Map must contain two fields, id and name. The OpenAI model. eg: gpt-5-nano
    prompt String
    The prompt to send to OpenAI
    maxTokens String
    Maximum number of tokens to generate in the response
    reasoningEffort String
    Constrains effort on reasoning for GPT-5 and o-series models. Value must be one of minimal, low, medium, high.
    reasoningSummary String
    Summary of the reasoning performed by the model for GPT-5 and o-series models. Value must be one of auto, concise, detailed.
    systemPrompt String
    The system prompt to send to OpenAI (optional)
    taskType String
    temperature Number
    Controls randomness in the response. Higher values make output more random
    topP Number
    Controls diversity via nucleus sampling. Lower values make output more focused

    Import

    rootly.WorkflowTaskCreateOpenaiChatCompletion can be imported using the import command.

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