Jump to

• Request
• Response

Create a Notification Template for a Project

post

/api/v2/projects/{id}/notification_templates_success/

Make a POST request to this resource with the following notification template fields to create a new notification template associated with this project.

• 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})

Add Notification Templates for a Project:

Make a POST request to this resource with only an id field to associate an existing notification template with this project.

Remove Notification Templates from this Project:

Make a POST request to this resource with id and disassociate fields to remove the notification template from this project without deleting the notification template.

Request

Supported Media Types

• application/json

Path Parameters

• id: string

Body ()

Root Schema : schema

Type: object

Show Source

• description(optional): string
• messages(optional): string
  Optional custom messages for notification template.
• name: string
• notification_configuration(optional): string
• notification_type: string
• organization: integer

{
    "properties":{
        "description":{
            "description":"",
            "type":"string"
        },
        "messages":{
            "description":"Optional custom messages for notification template.",
            "type":"string"
        },
        "name":{
            "description":"",
            "type":"string"
        },
        "notification_configuration":{
            "description":"",
            "type":"string"
        },
        "notification_type":{
            "description":"",
            "type":"string"
        },
        "organization":{
            "description":"",
            "type":"integer"
        }
    },
    "required":[
        "name",
        "organization",
        "notification_type"
    ],
    "type":"object"
}

Back to Top

Response

201 Response

Back to Top