Create a Notification Template for a Workflow Job Template

post

/api/v2/workflow_job_templates/{id}/notification_templates_started/

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

  • 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 Workflow Job Template:

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

Remove Notification Templates from this Workflow Job Template:

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

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : schema
Example:
{
    "associate":true,
    "id":"1"
}
Back to Top

Response

201 Response

Back to Top