1. Registry
  2. Packages
  3. incident.io
  4. API Docs
  5. AnnouncementTemplate
Viewing docs for incident.io v0.4.1
published on Wednesday, Oct 21, 2026 by incident-io
incident logo incident.io
Viewing docs for incident.io v0.4.1
published on Wednesday, Oct 21, 2026 by incident-io

    Create and manage announcement templates.

    An announcement template controls which fields and actions appear on an announcement post. Each announcement rule renders its posts with one template.

    fields and actions appear on the post in the order they’re listed.

    Which template is the organisation’s default is set in the dashboard, and the default template can’t be deleted: import it to manage its fields, but remove it from state rather than destroying it.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as incident from "@incident-io/pulumi";
    
    // A template for major incidents: severity and status first, then a note asking people
    // to join. Fields and actions appear on the post in the order they're listed.
    const majorIncidents = new incident.AnnouncementTemplate("major_incidents", {
        name: "Major incidents",
        fields: [
            {
                fieldType: "announcement_post_fields_severity",
                emoji: "fire",
            },
            {
                fieldType: "announcement_post_fields_status",
            },
            {
                fieldType: "announcement_post_fields_rich_text",
                richText: {
                    type: "markdown",
                    contents: "If you can help, please join {{incident.reference}}",
                },
            },
        ],
        actions: [
            {
                actionType: "announcement_post_actions_join_call",
            },
            {
                actionType: "announcement_post_actions_homepage",
            },
        ],
    });
    
    import pulumi
    import pulumi_incident as incident
    
    # A template for major incidents: severity and status first, then a note asking people
    # to join. Fields and actions appear on the post in the order they're listed.
    major_incidents = incident.AnnouncementTemplate("major_incidents",
        name="Major incidents",
        fields=[
            {
                "field_type": "announcement_post_fields_severity",
                "emoji": "fire",
            },
            {
                "field_type": "announcement_post_fields_status",
            },
            {
                "field_type": "announcement_post_fields_rich_text",
                "rich_text": {
                    "type": "markdown",
                    "contents": "If you can help, please join {{incident.reference}}",
                },
            },
        ],
        actions=[
            {
                "action_type": "announcement_post_actions_join_call",
            },
            {
                "action_type": "announcement_post_actions_homepage",
            },
        ])
    
    package main
    
    import (
    	"github.com/incident-io/pulumi-incident/sdk/go/incident"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// A template for major incidents: severity and status first, then a note asking people
    		// to join. Fields and actions appear on the post in the order they're listed.
    		_, err := incident.NewAnnouncementTemplate(ctx, "major_incidents", &incident.AnnouncementTemplateArgs{
    			Name: pulumi.String("Major incidents"),
    			Fields: incident.AnnouncementTemplateFieldArray{
    				&incident.AnnouncementTemplateFieldArgs{
    					FieldType: pulumi.String("announcement_post_fields_severity"),
    					Emoji:     pulumi.String("fire"),
    				},
    				&incident.AnnouncementTemplateFieldArgs{
    					FieldType: pulumi.String("announcement_post_fields_status"),
    				},
    				&incident.AnnouncementTemplateFieldArgs{
    					FieldType: pulumi.String("announcement_post_fields_rich_text"),
    					RichText: &incident.AnnouncementTemplateFieldRichTextArgs{
    						Type:     pulumi.String("markdown"),
    						Contents: pulumi.String("If you can help, please join {{incident.reference}}"),
    					},
    				},
    			},
    			Actions: incident.AnnouncementTemplateActionArray{
    				&incident.AnnouncementTemplateActionArgs{
    					ActionType: pulumi.String("announcement_post_actions_join_call"),
    				},
    				&incident.AnnouncementTemplateActionArgs{
    					ActionType: pulumi.String("announcement_post_actions_homepage"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Incident = Pulumi.Incident;
    
    return await Deployment.RunAsync(() => 
    {
        // A template for major incidents: severity and status first, then a note asking people
        // to join. Fields and actions appear on the post in the order they're listed.
        var majorIncidents = new Incident.AnnouncementTemplate("major_incidents", new()
        {
            Name = "Major incidents",
            Fields = new[]
            {
                new Incident.Inputs.AnnouncementTemplateFieldArgs
                {
                    FieldType = "announcement_post_fields_severity",
                    Emoji = "fire",
                },
                new Incident.Inputs.AnnouncementTemplateFieldArgs
                {
                    FieldType = "announcement_post_fields_status",
                },
                new Incident.Inputs.AnnouncementTemplateFieldArgs
                {
                    FieldType = "announcement_post_fields_rich_text",
                    RichText = new Incident.Inputs.AnnouncementTemplateFieldRichTextArgs
                    {
                        Type = "markdown",
                        Contents = "If you can help, please join {{incident.reference}}",
                    },
                },
            },
            Actions = new[]
            {
                new Incident.Inputs.AnnouncementTemplateActionArgs
                {
                    ActionType = "announcement_post_actions_join_call",
                },
                new Incident.Inputs.AnnouncementTemplateActionArgs
                {
                    ActionType = "announcement_post_actions_homepage",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.incident.AnnouncementTemplate;
    import com.pulumi.incident.AnnouncementTemplateArgs;
    import com.pulumi.incident.inputs.AnnouncementTemplateFieldArgs;
    import com.pulumi.incident.inputs.AnnouncementTemplateFieldRichTextArgs;
    import com.pulumi.incident.inputs.AnnouncementTemplateActionArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            // A template for major incidents: severity and status first, then a note asking people
            // to join. Fields and actions appear on the post in the order they're listed.
            var majorIncidents = new AnnouncementTemplate("majorIncidents", AnnouncementTemplateArgs.builder()
                .name("Major incidents")
                .fields(            
                    AnnouncementTemplateFieldArgs.builder()
                        .fieldType("announcement_post_fields_severity")
                        .emoji("fire")
                        .build(),
                    AnnouncementTemplateFieldArgs.builder()
                        .fieldType("announcement_post_fields_status")
                        .build(),
                    AnnouncementTemplateFieldArgs.builder()
                        .fieldType("announcement_post_fields_rich_text")
                        .richText(AnnouncementTemplateFieldRichTextArgs.builder()
                            .type("markdown")
                            .contents("If you can help, please join {{incident.reference}}")
                            .build())
                        .build())
                .actions(            
                    AnnouncementTemplateActionArgs.builder()
                        .actionType("announcement_post_actions_join_call")
                        .build(),
                    AnnouncementTemplateActionArgs.builder()
                        .actionType("announcement_post_actions_homepage")
                        .build())
                .build());
    
        }
    }
    
    resources:
      # A template for major incidents: severity and status first, then a note asking people
      # to join. Fields and actions appear on the post in the order they're listed.
      majorIncidents:
        type: incident:AnnouncementTemplate
        name: major_incidents
        properties:
          name: Major incidents
          fields:
            - fieldType: announcement_post_fields_severity
              emoji: fire
            - fieldType: announcement_post_fields_status
            - fieldType: announcement_post_fields_rich_text
              richText:
                type: markdown
                contents: If you can help, please join {{incident.reference}}
          actions:
            - actionType: announcement_post_actions_join_call
            - actionType: announcement_post_actions_homepage
    
    pulumi {
      required_providers {
        incident = {
          source = "pulumi/incident"
        }
      }
    }
    
    # A template for major incidents: severity and status first, then a note asking people
    # to join. Fields and actions appear on the post in the order they're listed.
    resource "incident_announcementtemplate" "major_incidents" {
      name = "Major incidents"
      fields {
        field_type = "announcement_post_fields_severity"
        emoji      = "fire"
      }
      fields {
        field_type = "announcement_post_fields_status"
      }
      fields {
        field_type = "announcement_post_fields_rich_text"
        rich_text = {
          type     = "markdown"
          contents = "If you can help, please join {{incident.reference}}"
        }
      }
      actions {
        action_type = "announcement_post_actions_join_call"
      }
      actions {
        action_type = "announcement_post_actions_homepage"
      }
    }
    

    Create AnnouncementTemplate Resource

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

    Constructor syntax

    new AnnouncementTemplate(name: string, args: AnnouncementTemplateArgs, opts?: CustomResourceOptions);
    @overload
    def AnnouncementTemplate(resource_name: str,
                             args: AnnouncementTemplateArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def AnnouncementTemplate(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             actions: Optional[Sequence[AnnouncementTemplateActionArgs]] = None,
                             fields: Optional[Sequence[AnnouncementTemplateFieldArgs]] = None,
                             name: Optional[str] = None,
                             owning_team_ids: Optional[Sequence[str]] = None)
    func NewAnnouncementTemplate(ctx *Context, name string, args AnnouncementTemplateArgs, opts ...ResourceOption) (*AnnouncementTemplate, error)
    public AnnouncementTemplate(string name, AnnouncementTemplateArgs args, CustomResourceOptions? opts = null)
    public AnnouncementTemplate(String name, AnnouncementTemplateArgs args)
    public AnnouncementTemplate(String name, AnnouncementTemplateArgs args, CustomResourceOptions options)
    
    type: incident:AnnouncementTemplate
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "incident_announcement_template" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args AnnouncementTemplateArgs
    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 AnnouncementTemplateArgs
    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 AnnouncementTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AnnouncementTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AnnouncementTemplateArgs
    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 announcementTemplateResource = new Incident.AnnouncementTemplate("announcementTemplateResource", new()
    {
        Actions = new[]
        {
            new Incident.Inputs.AnnouncementTemplateActionArgs
            {
                ActionType = "string",
                Emoji = "string",
            },
        },
        Fields = new[]
        {
            new Incident.Inputs.AnnouncementTemplateFieldArgs
            {
                FieldType = "string",
                CustomFieldId = "string",
                Emoji = "string",
                IncidentRoleId = "string",
                IncidentTimestampId = "string",
                RichText = new Incident.Inputs.AnnouncementTemplateFieldRichTextArgs
                {
                    Contents = "string",
                    Type = "string",
                },
            },
        },
        Name = "string",
        OwningTeamIds = new[]
        {
            "string",
        },
    });
    
    example, err := incident.NewAnnouncementTemplate(ctx, "announcementTemplateResource", &incident.AnnouncementTemplateArgs{
    	Actions: incident.AnnouncementTemplateActionArray{
    		&incident.AnnouncementTemplateActionArgs{
    			ActionType: pulumi.String("string"),
    			Emoji:      pulumi.String("string"),
    		},
    	},
    	Fields: incident.AnnouncementTemplateFieldArray{
    		&incident.AnnouncementTemplateFieldArgs{
    			FieldType:           pulumi.String("string"),
    			CustomFieldId:       pulumi.String("string"),
    			Emoji:               pulumi.String("string"),
    			IncidentRoleId:      pulumi.String("string"),
    			IncidentTimestampId: pulumi.String("string"),
    			RichText: &incident.AnnouncementTemplateFieldRichTextArgs{
    				Contents: pulumi.String("string"),
    				Type:     pulumi.String("string"),
    			},
    		},
    	},
    	Name: pulumi.String("string"),
    	OwningTeamIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    resource "incident_announcement_template" "announcementTemplateResource" {
      lifecycle {
        create_before_destroy = true
      }
      actions {
        action_type = "string"
        emoji       = "string"
      }
      fields {
        field_type            = "string"
        custom_field_id       = "string"
        emoji                 = "string"
        incident_role_id      = "string"
        incident_timestamp_id = "string"
        rich_text = {
          contents = "string"
          type     = "string"
        }
      }
      name            = "string"
      owning_team_ids = ["string"]
    }
    
    var announcementTemplateResource = new AnnouncementTemplate("announcementTemplateResource", AnnouncementTemplateArgs.builder()
        .actions(AnnouncementTemplateActionArgs.builder()
            .actionType("string")
            .emoji("string")
            .build())
        .fields(AnnouncementTemplateFieldArgs.builder()
            .fieldType("string")
            .customFieldId("string")
            .emoji("string")
            .incidentRoleId("string")
            .incidentTimestampId("string")
            .richText(AnnouncementTemplateFieldRichTextArgs.builder()
                .contents("string")
                .type("string")
                .build())
            .build())
        .name("string")
        .owningTeamIds("string")
        .build());
    
    announcement_template_resource = incident.AnnouncementTemplate("announcementTemplateResource",
        actions=[{
            "action_type": "string",
            "emoji": "string",
        }],
        fields=[{
            "field_type": "string",
            "custom_field_id": "string",
            "emoji": "string",
            "incident_role_id": "string",
            "incident_timestamp_id": "string",
            "rich_text": {
                "contents": "string",
                "type": "string",
            },
        }],
        name="string",
        owning_team_ids=["string"])
    
    const announcementTemplateResource = new incident.AnnouncementTemplate("announcementTemplateResource", {
        actions: [{
            actionType: "string",
            emoji: "string",
        }],
        fields: [{
            fieldType: "string",
            customFieldId: "string",
            emoji: "string",
            incidentRoleId: "string",
            incidentTimestampId: "string",
            richText: {
                contents: "string",
                type: "string",
            },
        }],
        name: "string",
        owningTeamIds: ["string"],
    });
    
    type: incident:AnnouncementTemplate
    properties:
        actions:
            - actionType: string
              emoji: string
        fields:
            - customFieldId: string
              emoji: string
              fieldType: string
              incidentRoleId: string
              incidentTimestampId: string
              richText:
                contents: string
                type: string
        name: string
        owningTeamIds:
            - string
    

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

    Actions List<AnnouncementTemplateAction>
    Actions shown on the announcement post, in rank order. Set actions = [] for a post with no actions.
    Fields List<AnnouncementTemplateField>
    Fields shown on the announcement post, in rank order. Set fields = [] for a post with no fields.
    Name string
    Name of this announcement template, unique within the organisation
    OwningTeamIds List<string>
    IDs of the teams that own this template
    Actions []AnnouncementTemplateActionArgs
    Actions shown on the announcement post, in rank order. Set actions = [] for a post with no actions.
    Fields []AnnouncementTemplateFieldArgs
    Fields shown on the announcement post, in rank order. Set fields = [] for a post with no fields.
    Name string
    Name of this announcement template, unique within the organisation
    OwningTeamIds []string
    IDs of the teams that own this template
    actions list(object)
    Actions shown on the announcement post, in rank order. Set actions = [] for a post with no actions.
    fields list(object)
    Fields shown on the announcement post, in rank order. Set fields = [] for a post with no fields.
    name string
    Name of this announcement template, unique within the organisation
    owning_team_ids list(string)
    IDs of the teams that own this template
    actions List<AnnouncementTemplateAction>
    Actions shown on the announcement post, in rank order. Set actions = [] for a post with no actions.
    fields List<AnnouncementTemplateField>
    Fields shown on the announcement post, in rank order. Set fields = [] for a post with no fields.
    name String
    Name of this announcement template, unique within the organisation
    owningTeamIds List<String>
    IDs of the teams that own this template
    actions AnnouncementTemplateAction[]
    Actions shown on the announcement post, in rank order. Set actions = [] for a post with no actions.
    fields AnnouncementTemplateField[]
    Fields shown on the announcement post, in rank order. Set fields = [] for a post with no fields.
    name string
    Name of this announcement template, unique within the organisation
    owningTeamIds string[]
    IDs of the teams that own this template
    actions Sequence[AnnouncementTemplateActionArgs]
    Actions shown on the announcement post, in rank order. Set actions = [] for a post with no actions.
    fields Sequence[AnnouncementTemplateFieldArgs]
    Fields shown on the announcement post, in rank order. Set fields = [] for a post with no fields.
    name str
    Name of this announcement template, unique within the organisation
    owning_team_ids Sequence[str]
    IDs of the teams that own this template
    actions List<Property Map>
    Actions shown on the announcement post, in rank order. Set actions = [] for a post with no actions.
    fields List<Property Map>
    Fields shown on the announcement post, in rank order. Set fields = [] for a post with no fields.
    name String
    Name of this announcement template, unique within the organisation
    owningTeamIds List<String>
    IDs of the teams that own this template

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    IsDefault bool
    Whether this is the organisation's default template, used by rules that don't choose one
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDefault bool
    Whether this is the organisation's default template, used by rules that don't choose one
    id string
    The provider-assigned unique ID for this managed resource.
    is_default bool
    Whether this is the organisation's default template, used by rules that don't choose one
    id String
    The provider-assigned unique ID for this managed resource.
    isDefault Boolean
    Whether this is the organisation's default template, used by rules that don't choose one
    id string
    The provider-assigned unique ID for this managed resource.
    isDefault boolean
    Whether this is the organisation's default template, used by rules that don't choose one
    id str
    The provider-assigned unique ID for this managed resource.
    is_default bool
    Whether this is the organisation's default template, used by rules that don't choose one
    id String
    The provider-assigned unique ID for this managed resource.
    isDefault Boolean
    Whether this is the organisation's default template, used by rules that don't choose one

    Look up Existing AnnouncementTemplate Resource

    Get an existing AnnouncementTemplate 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?: AnnouncementTemplateState, opts?: CustomResourceOptions): AnnouncementTemplate
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            actions: Optional[Sequence[AnnouncementTemplateActionArgs]] = None,
            fields: Optional[Sequence[AnnouncementTemplateFieldArgs]] = None,
            is_default: Optional[bool] = None,
            name: Optional[str] = None,
            owning_team_ids: Optional[Sequence[str]] = None) -> AnnouncementTemplate
    func GetAnnouncementTemplate(ctx *Context, name string, id IDInput, state *AnnouncementTemplateState, opts ...ResourceOption) (*AnnouncementTemplate, error)
    public static AnnouncementTemplate Get(string name, Input<string> id, AnnouncementTemplateState? state, CustomResourceOptions? opts = null)
    public static AnnouncementTemplate get(String name, Output<String> id, AnnouncementTemplateState state, CustomResourceOptions options)
    resources:  _:    type: incident:AnnouncementTemplate    get:      id: ${id}
    import {
      to = incident_announcement_template.example
      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:
    Actions List<AnnouncementTemplateAction>
    Actions shown on the announcement post, in rank order. Set actions = [] for a post with no actions.
    Fields List<AnnouncementTemplateField>
    Fields shown on the announcement post, in rank order. Set fields = [] for a post with no fields.
    IsDefault bool
    Whether this is the organisation's default template, used by rules that don't choose one
    Name string
    Name of this announcement template, unique within the organisation
    OwningTeamIds List<string>
    IDs of the teams that own this template
    Actions []AnnouncementTemplateActionArgs
    Actions shown on the announcement post, in rank order. Set actions = [] for a post with no actions.
    Fields []AnnouncementTemplateFieldArgs
    Fields shown on the announcement post, in rank order. Set fields = [] for a post with no fields.
    IsDefault bool
    Whether this is the organisation's default template, used by rules that don't choose one
    Name string
    Name of this announcement template, unique within the organisation
    OwningTeamIds []string
    IDs of the teams that own this template
    actions list(object)
    Actions shown on the announcement post, in rank order. Set actions = [] for a post with no actions.
    fields list(object)
    Fields shown on the announcement post, in rank order. Set fields = [] for a post with no fields.
    is_default bool
    Whether this is the organisation's default template, used by rules that don't choose one
    name string
    Name of this announcement template, unique within the organisation
    owning_team_ids list(string)
    IDs of the teams that own this template
    actions List<AnnouncementTemplateAction>
    Actions shown on the announcement post, in rank order. Set actions = [] for a post with no actions.
    fields List<AnnouncementTemplateField>
    Fields shown on the announcement post, in rank order. Set fields = [] for a post with no fields.
    isDefault Boolean
    Whether this is the organisation's default template, used by rules that don't choose one
    name String
    Name of this announcement template, unique within the organisation
    owningTeamIds List<String>
    IDs of the teams that own this template
    actions AnnouncementTemplateAction[]
    Actions shown on the announcement post, in rank order. Set actions = [] for a post with no actions.
    fields AnnouncementTemplateField[]
    Fields shown on the announcement post, in rank order. Set fields = [] for a post with no fields.
    isDefault boolean
    Whether this is the organisation's default template, used by rules that don't choose one
    name string
    Name of this announcement template, unique within the organisation
    owningTeamIds string[]
    IDs of the teams that own this template
    actions Sequence[AnnouncementTemplateActionArgs]
    Actions shown on the announcement post, in rank order. Set actions = [] for a post with no actions.
    fields Sequence[AnnouncementTemplateFieldArgs]
    Fields shown on the announcement post, in rank order. Set fields = [] for a post with no fields.
    is_default bool
    Whether this is the organisation's default template, used by rules that don't choose one
    name str
    Name of this announcement template, unique within the organisation
    owning_team_ids Sequence[str]
    IDs of the teams that own this template
    actions List<Property Map>
    Actions shown on the announcement post, in rank order. Set actions = [] for a post with no actions.
    fields List<Property Map>
    Fields shown on the announcement post, in rank order. Set fields = [] for a post with no fields.
    isDefault Boolean
    Whether this is the organisation's default template, used by rules that don't choose one
    name String
    Name of this announcement template, unique within the organisation
    owningTeamIds List<String>
    IDs of the teams that own this template

    Supporting Types

    AnnouncementTemplateAction, AnnouncementTemplateActionArgs

    ActionType string
    Type of this action. Possible values are: announcementPostActionsHomepage, announcementPostActionsSubscribe, announcementPostActionsJoinCall, announcementPostActionsJiraTicket, announcementPostActionsInternalStatusPage, announcementPostActionsPublicStatusPage, announcementPostActionsPostmortem, announcementPostActionsCreateChannel, announcementPostActionsViewAlert, announcementPostActionsTriage, announcementPostActionsEscalate, announcementPostActionsShareUpdate, announcementPostActionsUpdateStatus, announcementPostActionsRequestAccess.
    Emoji string
    Emoji shown on this action's button, as a Slack emoji name
    ActionType string
    Type of this action. Possible values are: announcementPostActionsHomepage, announcementPostActionsSubscribe, announcementPostActionsJoinCall, announcementPostActionsJiraTicket, announcementPostActionsInternalStatusPage, announcementPostActionsPublicStatusPage, announcementPostActionsPostmortem, announcementPostActionsCreateChannel, announcementPostActionsViewAlert, announcementPostActionsTriage, announcementPostActionsEscalate, announcementPostActionsShareUpdate, announcementPostActionsUpdateStatus, announcementPostActionsRequestAccess.
    Emoji string
    Emoji shown on this action's button, as a Slack emoji name
    action_type string
    Type of this action. Possible values are: announcementPostActionsHomepage, announcementPostActionsSubscribe, announcementPostActionsJoinCall, announcementPostActionsJiraTicket, announcementPostActionsInternalStatusPage, announcementPostActionsPublicStatusPage, announcementPostActionsPostmortem, announcementPostActionsCreateChannel, announcementPostActionsViewAlert, announcementPostActionsTriage, announcementPostActionsEscalate, announcementPostActionsShareUpdate, announcementPostActionsUpdateStatus, announcementPostActionsRequestAccess.
    emoji string
    Emoji shown on this action's button, as a Slack emoji name
    actionType String
    Type of this action. Possible values are: announcementPostActionsHomepage, announcementPostActionsSubscribe, announcementPostActionsJoinCall, announcementPostActionsJiraTicket, announcementPostActionsInternalStatusPage, announcementPostActionsPublicStatusPage, announcementPostActionsPostmortem, announcementPostActionsCreateChannel, announcementPostActionsViewAlert, announcementPostActionsTriage, announcementPostActionsEscalate, announcementPostActionsShareUpdate, announcementPostActionsUpdateStatus, announcementPostActionsRequestAccess.
    emoji String
    Emoji shown on this action's button, as a Slack emoji name
    actionType string
    Type of this action. Possible values are: announcementPostActionsHomepage, announcementPostActionsSubscribe, announcementPostActionsJoinCall, announcementPostActionsJiraTicket, announcementPostActionsInternalStatusPage, announcementPostActionsPublicStatusPage, announcementPostActionsPostmortem, announcementPostActionsCreateChannel, announcementPostActionsViewAlert, announcementPostActionsTriage, announcementPostActionsEscalate, announcementPostActionsShareUpdate, announcementPostActionsUpdateStatus, announcementPostActionsRequestAccess.
    emoji string
    Emoji shown on this action's button, as a Slack emoji name
    action_type str
    Type of this action. Possible values are: announcementPostActionsHomepage, announcementPostActionsSubscribe, announcementPostActionsJoinCall, announcementPostActionsJiraTicket, announcementPostActionsInternalStatusPage, announcementPostActionsPublicStatusPage, announcementPostActionsPostmortem, announcementPostActionsCreateChannel, announcementPostActionsViewAlert, announcementPostActionsTriage, announcementPostActionsEscalate, announcementPostActionsShareUpdate, announcementPostActionsUpdateStatus, announcementPostActionsRequestAccess.
    emoji str
    Emoji shown on this action's button, as a Slack emoji name
    actionType String
    Type of this action. Possible values are: announcementPostActionsHomepage, announcementPostActionsSubscribe, announcementPostActionsJoinCall, announcementPostActionsJiraTicket, announcementPostActionsInternalStatusPage, announcementPostActionsPublicStatusPage, announcementPostActionsPostmortem, announcementPostActionsCreateChannel, announcementPostActionsViewAlert, announcementPostActionsTriage, announcementPostActionsEscalate, announcementPostActionsShareUpdate, announcementPostActionsUpdateStatus, announcementPostActionsRequestAccess.
    emoji String
    Emoji shown on this action's button, as a Slack emoji name

    AnnouncementTemplateField, AnnouncementTemplateFieldArgs

    FieldType string
    Type of this field. Possible values are: announcementPostFieldsStatus, announcementPostFieldsIncidentType, announcementPostFieldsSeverity, announcementPostFieldsRole, announcementPostFieldsDescription, announcementPostFieldsCustomField, announcementPostFieldsTimestamp, announcementPostFieldsCreator, announcementPostFieldsSlack, announcementPostFieldsRichText.
    CustomFieldId string
    ID of the custom field to show. Required for custom field fields.
    Emoji string
    Emoji shown next to this field, as a Slack emoji name
    IncidentRoleId string
    ID of the incident role to show. Required for incident role fields.
    IncidentTimestampId string
    ID of the incident timestamp to show. Required for incident timestamp fields.
    RichText AnnouncementTemplateFieldRichText
    Content of a rich text field. The type says how contents is written.
    FieldType string
    Type of this field. Possible values are: announcementPostFieldsStatus, announcementPostFieldsIncidentType, announcementPostFieldsSeverity, announcementPostFieldsRole, announcementPostFieldsDescription, announcementPostFieldsCustomField, announcementPostFieldsTimestamp, announcementPostFieldsCreator, announcementPostFieldsSlack, announcementPostFieldsRichText.
    CustomFieldId string
    ID of the custom field to show. Required for custom field fields.
    Emoji string
    Emoji shown next to this field, as a Slack emoji name
    IncidentRoleId string
    ID of the incident role to show. Required for incident role fields.
    IncidentTimestampId string
    ID of the incident timestamp to show. Required for incident timestamp fields.
    RichText AnnouncementTemplateFieldRichText
    Content of a rich text field. The type says how contents is written.
    field_type string
    Type of this field. Possible values are: announcementPostFieldsStatus, announcementPostFieldsIncidentType, announcementPostFieldsSeverity, announcementPostFieldsRole, announcementPostFieldsDescription, announcementPostFieldsCustomField, announcementPostFieldsTimestamp, announcementPostFieldsCreator, announcementPostFieldsSlack, announcementPostFieldsRichText.
    custom_field_id string
    ID of the custom field to show. Required for custom field fields.
    emoji string
    Emoji shown next to this field, as a Slack emoji name
    incident_role_id string
    ID of the incident role to show. Required for incident role fields.
    incident_timestamp_id string
    ID of the incident timestamp to show. Required for incident timestamp fields.
    rich_text object
    Content of a rich text field. The type says how contents is written.
    fieldType String
    Type of this field. Possible values are: announcementPostFieldsStatus, announcementPostFieldsIncidentType, announcementPostFieldsSeverity, announcementPostFieldsRole, announcementPostFieldsDescription, announcementPostFieldsCustomField, announcementPostFieldsTimestamp, announcementPostFieldsCreator, announcementPostFieldsSlack, announcementPostFieldsRichText.
    customFieldId String
    ID of the custom field to show. Required for custom field fields.
    emoji String
    Emoji shown next to this field, as a Slack emoji name
    incidentRoleId String
    ID of the incident role to show. Required for incident role fields.
    incidentTimestampId String
    ID of the incident timestamp to show. Required for incident timestamp fields.
    richText AnnouncementTemplateFieldRichText
    Content of a rich text field. The type says how contents is written.
    fieldType string
    Type of this field. Possible values are: announcementPostFieldsStatus, announcementPostFieldsIncidentType, announcementPostFieldsSeverity, announcementPostFieldsRole, announcementPostFieldsDescription, announcementPostFieldsCustomField, announcementPostFieldsTimestamp, announcementPostFieldsCreator, announcementPostFieldsSlack, announcementPostFieldsRichText.
    customFieldId string
    ID of the custom field to show. Required for custom field fields.
    emoji string
    Emoji shown next to this field, as a Slack emoji name
    incidentRoleId string
    ID of the incident role to show. Required for incident role fields.
    incidentTimestampId string
    ID of the incident timestamp to show. Required for incident timestamp fields.
    richText AnnouncementTemplateFieldRichText
    Content of a rich text field. The type says how contents is written.
    field_type str
    Type of this field. Possible values are: announcementPostFieldsStatus, announcementPostFieldsIncidentType, announcementPostFieldsSeverity, announcementPostFieldsRole, announcementPostFieldsDescription, announcementPostFieldsCustomField, announcementPostFieldsTimestamp, announcementPostFieldsCreator, announcementPostFieldsSlack, announcementPostFieldsRichText.
    custom_field_id str
    ID of the custom field to show. Required for custom field fields.
    emoji str
    Emoji shown next to this field, as a Slack emoji name
    incident_role_id str
    ID of the incident role to show. Required for incident role fields.
    incident_timestamp_id str
    ID of the incident timestamp to show. Required for incident timestamp fields.
    rich_text AnnouncementTemplateFieldRichText
    Content of a rich text field. The type says how contents is written.
    fieldType String
    Type of this field. Possible values are: announcementPostFieldsStatus, announcementPostFieldsIncidentType, announcementPostFieldsSeverity, announcementPostFieldsRole, announcementPostFieldsDescription, announcementPostFieldsCustomField, announcementPostFieldsTimestamp, announcementPostFieldsCreator, announcementPostFieldsSlack, announcementPostFieldsRichText.
    customFieldId String
    ID of the custom field to show. Required for custom field fields.
    emoji String
    Emoji shown next to this field, as a Slack emoji name
    incidentRoleId String
    ID of the incident role to show. Required for incident role fields.
    incidentTimestampId String
    ID of the incident timestamp to show. Required for incident timestamp fields.
    richText Property Map
    Content of a rich text field. The type says how contents is written.

    AnnouncementTemplateFieldRichText, AnnouncementTemplateFieldRichTextArgs

    Contents string
    The content, as markdown. Write incident variables as {{name}}, e.g. {{incident.reference}}.
    Type string
    How contents is written. Only markdown is supported today. Possible values are: markdown.
    Contents string
    The content, as markdown. Write incident variables as {{name}}, e.g. {{incident.reference}}.
    Type string
    How contents is written. Only markdown is supported today. Possible values are: markdown.
    contents string
    The content, as markdown. Write incident variables as {{name}}, e.g. {{incident.reference}}.
    type string
    How contents is written. Only markdown is supported today. Possible values are: markdown.
    contents String
    The content, as markdown. Write incident variables as {{name}}, e.g. {{incident.reference}}.
    type String
    How contents is written. Only markdown is supported today. Possible values are: markdown.
    contents string
    The content, as markdown. Write incident variables as {{name}}, e.g. {{incident.reference}}.
    type string
    How contents is written. Only markdown is supported today. Possible values are: markdown.
    contents str
    The content, as markdown. Write incident variables as {{name}}, e.g. {{incident.reference}}.
    type str
    How contents is written. Only markdown is supported today. Possible values are: markdown.
    contents String
    The content, as markdown. Write incident variables as {{name}}, e.g. {{incident.reference}}.
    type String
    How contents is written. Only markdown is supported today. Possible values are: markdown.

    Import

    Import is supported using an import block or the pulumi import command:

    The pulumi import command can be used, for example:

    !/bin/bash

    Import an announcement template using its ID Replace the ID with a real ID from your incident.io organization

    $ pulumi import incident:index/announcementTemplate:AnnouncementTemplate example 01ABC123DEF456GHI789JKL
    

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

    Package Details

    Repository
    incident incident-io/pulumi-incident
    License
    MIT
    Notes
    This Pulumi package is based on the incident Terraform Provider.
    incident logo incident.io
    Viewing docs for incident.io v0.4.1
    published on Wednesday, Oct 21, 2026 by incident-io

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial