Edit in GitHubLog an issue

Tutorial Introduction

The Cloud Manager API Tutorial walks through the process of creating an integration between Cloud Manager and either Microsoft Teams or Slack.

The files used in this tutorial can all be found in GitHub in the repository at https://github.com/AdobeDocs/cloudmanager-api-tutorial. The result of each tutorial step is in a separate file:

StepDescriptionFile
1Basic Webhook Setupstep1.js
2Webhook Signature Validationstep2.js
3Looking for Specific Event Typestep3.js
4Getting an Access Tokenstep4.js
5Getting Execution Datastep5.js
6Getting Program Datastep6.js
7Notifying Slackstep7-slack.js
7Notifying Microsoft Teamsstep7-teams.js

Prerequisites#

Before starting the tutorial, you must first set up an integration in the Adobe I/O Console. First, follow the instructions on the Creating an API Integration to create an API integration. You'll add the Event Provider integration in a later step.

Project Initialization#

Configuration Variables#

This tutorial does involved coding, so you're going to want to open up your favorite IDE now. Create a new project in your IDE with an empty folder. In this project, create a file named .env. This file is going to hold various configuration variables which should be kept out of the code.

Populate this file with the following content:

Copied to your clipboard
1PORT=4000
2ORGANIZATION_ID=
3TECHNICAL_ACCOUNT_EMAIL=
4API_KEY=
5CLIENT_SECRET=
6PRIVATE_KEY=

Let's go through each of these and set them.

  1. PORT -- this is the port on which the webhook will listen. 4000 is a good default value, unless something else is using this port.
  2. ORGANIZATION_ID -- this can be found in the Client Credentials section of the Adobe I/O Console.
  3. TECHNICAL_ACCOUNT_EMAIL -- this can be found in the Client Credentials section of the Adobe I/O Console.
  4. API_KEY -- this can be found in the Client Credentials section of the Adobe I/O Console.
  5. CLIENT_SECRET -- this can be found in the Client Credentials section of the Adobe I/O Console. Note that you have to click the Retrieve client secret button to reveal this.
  6. PRIVATE_KEY -- this is the content of the private.key file generated by OpenSSL without any line breaks, i.e. all on one line.

Node.js Installation#

This tutorial is written in JavaScript using Node.js. If you don't have Node.js installed, now is the time to do so. You'll also need npm, the Node Package Manager, as this tutorial uses a number of third-party dependencies, distributed as Node packages. Most of the time, npm is installed automatically when you install Node.js.

Node.js Initialization#

In order to use the Node packages dependened upon, you'll need to create a basic package.json file. To do this, open up a Terminal/Shell window in the project directory and run

Copied to your clipboard
npm init -y

from the Terminal or Shell.

Next Step#

With all that done, you're ready to start the actual tutorial. Continue to Step 1.

  • Privacy
  • Terms of Use
  • Do not sell my personal information
  • AdChoices
Copyright © 2021 Adobe. All rights reserved.