Tutorial Step 7 - Sending Notifications

Congratulations! You've reached the end of the tutorial. This last step actually has nothing to do with Cloud Manager or Adobe I/O. In this step, we're going to take the data retrieved and send a message to either Microsoft Teams or Slack. Or you could do both if you are feeling adventurous.

Setting up a Notification Webhook

For both Microsoft Teams and Slack, notifications can be sent via an Incoming Webhook integration. The details are slightly different, but both follow the same basic concept -- when you want to post a message to a channel, you can make an HTTP POST request to a special URL generated specifically for this purpose.

Documentation to create a webhook URL for Microsoft Teams can be found here

Documentation to create a webhook URL for Slack can be found here.

Notifying Slack

Sending a Slack notification can be done with just a simple JSON object containing a text property. Let's create a new function which sends such an object to the webhook. To make the webhook easy to chnage, add a new variable to your .env file named SLACK_WEBHOOK and create this function:

Copy
function notifySlack (message) {
  fetch(process.env.SLACK_WEBHOOK, {
    'method': 'POST',
    'headers': { 'Content-Type': 'application/json' },
    'body': JSON.stringify({
      'text': message
    })
  })
}
Copied to your clipboard
function notifySlack (message) {
  fetch(process.env.SLACK_WEBHOOK, {
    'method': 'POST',
    'headers': { 'Content-Type': 'application/json' },
    'body': JSON.stringify({
      'text': message
    })
  })
}

And the invoke this function instead of logging:

Copy
if (STARTED === event['@type'] &&
      EXECUTION === event['xdmEventEnvelope:objectType']) {
  console.log('received execution start event')

  const executionUrl = event['activitystreams:object']['@id']

  getExecution(executionUrl).then(execution => {
    notifySlack(`Execution for ${execution.program.name} started`)
  })
}
Copied to your clipboard
if (STARTED === event['@type'] &&
      EXECUTION === event['xdmEventEnvelope:objectType']) {
  console.log('received execution start event')

  const executionUrl = event['activitystreams:object']['@id']

  getExecution(executionUrl).then(execution => {
    notifySlack(`Execution for ${execution.program.name} started`)
  })
}

This will produce a Slack message which looks like this:

Notifying Microsoft Teams

Sending a Microsoft Teams notification can be as simple as Slack -- just a single text property. But Teams also supports some slightly fancier formatting options -- notifications can have a title and banner color, among other options. As with the Slack webhook, you should put the webhook URL in your .env file in a variable named TEAMS_WEBHOOK.

Copy
function notifyTeams (message) {
  fetch(process.env.TEAMS_WEBHOOK, {
    'method': 'POST',
    'headers': { 'Content-Type': 'application/json' },
    'body': JSON.stringify({
      '@context': 'https://schema.org/extensions',
      '@type': 'MessageCard',
      'themeColor': '0072C6',
      'title': 'Update from Cloud Manager',
      'text': message
    })
  })
}
Copied to your clipboard
function notifyTeams (message) {
  fetch(process.env.TEAMS_WEBHOOK, {
    'method': 'POST',
    'headers': { 'Content-Type': 'application/json' },
    'body': JSON.stringify({
      '@context': 'https://schema.org/extensions',
      '@type': 'MessageCard',
      'themeColor': '0072C6',
      'title': 'Update from Cloud Manager',
      'text': message
    })
  })
}

And then invoke this function:

Copy
if (STARTED === event['@type'] &&
      EXECUTION === event['xdmEventEnvelope:objectType']) {
  console.log('received execution start event')

  const executionUrl = event['activitystreams:object']['@id']

  getExecution(executionUrl).then(execution => {
    notifyTeams(`Execution for ${execution.program.name} started`)
  })
}
Copied to your clipboard
if (STARTED === event['@type'] &&
      EXECUTION === event['xdmEventEnvelope:objectType']) {
  console.log('received execution start event')

  const executionUrl = event['activitystreams:object']['@id']

  getExecution(executionUrl).then(execution => {
    notifyTeams(`Execution for ${execution.program.name} started`)
  })
}

This will produce a Microsoft Teams message which looks like this:

Last updated 3/4/2022

Was this helpful?

Yes

No