Jump to

• Request
• Response

Update a Notification Template

patch

/api/v2/notification_templates/{id}/

Make a PUT or PATCH request to this resource to update this notification template. The following fields may be modified:

• name: Name of this notification template. (string, required)
• description: Optional description of this notification template. (string, default="")
• organization: (id, required)
• notification_type: (choice, required)
  • email: Email
  • grafana: Grafana
  • irc: IRC
  • mattermost: Mattermost
  • pagerduty: Pagerduty
  • rocketchat: Rocket.Chat
  • slack: Slack
  • twilio: Twilio
  • webhook: Webhook
• notification_configuration: (json, default={})
• messages: Optional custom messages for notification template. (json, default={'started': None, 'success': None, 'error': None, 'workflow_approval': None})

For a PATCH request, include only the fields that are being modified.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Body ()

Root Schema : NotificationTemplate

Type: object

Show Source

• created: string
  Title: Created

  Read Only: true
• description: string
  Title: Description
• id: integer
  Title: ID

  Read Only: true
• messages: object Messages
  Title: Messages

  Optional custom messages for notification template.
• modified: string
  Title: Modified

  Read Only: true
• name(required): string
  Title: Name

  Minimum Length: 1

  Maximum Length: 512
• notification_configuration: object Notification configuration
  Title: Notification configuration
• notification_type(required): string
  Title: Notification type

  Allowed Values: [ "email", "grafana", "irc", "mattermost", "pagerduty", "rocketchat", "slack", "twilio", "webhook" ]
• organization(required): integer
  Title: Organization
• related: string
  Title: Related

  Read Only: true
• summary_fields: string
  Title: Summary fields

  Read Only: true
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: true

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "messages":{
            "default":{
            },
            "description":"Optional custom messages for notification template.",
            "title":"Messages",
            "type":"object",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "notification_configuration":{
            "title":"Notification configuration",
            "type":"object"
        },
        "notification_type":{
            "enum":[
                "email",
                "grafana",
                "irc",
                "mattermost",
                "pagerduty",
                "rocketchat",
                "slack",
                "twilio",
                "webhook"
            ],
            "title":"Notification type",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "name",
        "organization",
        "notification_type"
    ],
    "type":"object"
}

Nested Schema : Messages

Type: object

Title: Messages

Optional custom messages for notification template.

Default Value: { }

Nested Schema : Notification configuration

Type: object

Title: Notification configuration

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : NotificationTemplate

Type: object

Show Source

• created: string
  Title: Created

  Read Only: true
• description: string
  Title: Description
• id: integer
  Title: ID

  Read Only: true
• messages: object Messages
  Title: Messages

  Optional custom messages for notification template.
• modified: string
  Title: Modified

  Read Only: true
• name(required): string
  Title: Name

  Minimum Length: 1

  Maximum Length: 512
• notification_configuration: object Notification configuration
  Title: Notification configuration
• notification_type(required): string
  Title: Notification type

  Allowed Values: [ "email", "grafana", "irc", "mattermost", "pagerduty", "rocketchat", "slack", "twilio", "webhook" ]
• organization(required): integer
  Title: Organization
• related: string
  Title: Related

  Read Only: true
• summary_fields: string
  Title: Summary fields

  Read Only: true
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: true

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "messages":{
            "default":{
            },
            "description":"Optional custom messages for notification template.",
            "title":"Messages",
            "type":"object",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "notification_configuration":{
            "title":"Notification configuration",
            "type":"object"
        },
        "notification_type":{
            "enum":[
                "email",
                "grafana",
                "irc",
                "mattermost",
                "pagerduty",
                "rocketchat",
                "slack",
                "twilio",
                "webhook"
            ],
            "title":"Notification type",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "name",
        "organization",
        "notification_type"
    ],
    "type":"object"
}

Nested Schema : Messages

Type: object

Title: Messages

Optional custom messages for notification template.

Default Value: { }

Nested Schema : Notification configuration

Type: object

Title: Notification configuration

Back to Top