notification

Create a CC notification

  • email (required, string) - The email address generated emails are sent to. Specify only one email address per notification.
  • subject (required, string) - The subject of the generated email.
  • body (required, string) - The body of the generated email.
  • events (required, array) - The IDs of events that trigger the notification. Specify at least one. Values:</br> dataload.process.schedule, </br> dataload.process.start,</br> dataload.process.finish.ok,</br> dataload.process.finish.error</br>
  • count (optional, integer) - The number of consecutive failures after which a notification about a failure should be sent. The maximum number is 30. The process must have automatic retry set (see Configuring Automatic Retry of Failed Processes).
post/gdc/projects/{projectId}/dataload/processes/{processId}/notificationRules

Request

  • Base URL
    https://secure.gooddata.com
  • Auth
    none declared

Request body

Example request

{
  "notificationRule": {
    "events": [
      "process.start",
      "process.end"
    ],
    "subject": "Your rockin' notification",
    "body": "The body text included in the generated email. Rock on.",
    "email": "kurt@yourock.com"
  }
}

Response

Created - create new notification rule (aka email subscription) for process

Example response

{
  "notificationRule": {
    "events": [
      "process.start",
      "process.end"
    ],
    "subject": "Your rockin' notification",
    "body": "The body text included in the generated email. Rock on.",
    "email": "kurt@yourock.com",
    "links": {
      "self": "/gdc/projects/{project_id}/dataload/processes/{process_id}/notificationRules/{rule_id}",
      "subscription": "/gdc/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}",
      "channel": [
        "/gdc/account/profile/{profile_id}/channelConfigurations/{channel_id}"
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.