Campaign Monitor

Overview

Authenticate

Events

Bulk APIs

Querying

API Docs

Authenticate with Campaign Monitor

You can authenticate with Campaign Monitor to create your own instance of the Campaign Monitor element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionality offered by the Campaign Monitor platform.

On this page
Authenticate Through the UI
Authenticate with Basic Through API
Authenticate with OAuth Through API
Parameters
Example Response for an Authenticated Element Instance

Authenticate Through the UI

Use the UI to authenticate with Campaign Monitor and create an element instance. Campaign Monitor authentication follows the typical OAuth 2 framework and you will need to sign in to Campaign Monitor as part of the process.

If you are configuring events, see the Events section.

To authenticate an element instance:

Sign in to Cloud Elements, and then search for Campaign Monitor in our Elements Catalog.
Hover over the element card, and then click Authenticate.
Enter a name for the element instance.
Note: The optional List IDs field is needed only for event setup. See Events.
In Authentication Type, keep the default OAuth2 or select Basic to authenticate with just an API Key.
- For OAuth 2.0 authentication, enter the Campaign Monitor Client ID in OAuth API Key and Client Secret in OAuth API Secret.
- For Basic authentication, enter the Campaign Monitor API Key in API Key.
Optionally type or select one or more Element Instance Tags to add to the authenticated element instance.
Click Create Instance.
If authenticating using OAuth 2.0, log in to Campaign Monitor, and then allow the connection.

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a virtual data resource, or use it in a formula template.

Authenticate with Basic Through API

Authenticating through API is similar to authenticating via the UI. Instead of clicking and typing through a series of buttons, text boxes, and menus, you will instead send a request to our /instances endpoint. The end result is the same, though: an authenticated element instance with a token and id.

To authenticate an element instance:

Construct a JSON body as shown below (see Parameters):

{
  "element": {
    "key": "campaignmonitor"
  },
  "configuration": {
    "authentication.type": "basic",
    "username": "<Campaign Monitor >"
  },
  "tags": [
    "<Add_Your_Tag>"
  ],
  "name": "<INSTANCE_NAME>"
}

Call the following, including the JSON body you constructed in the previous step:
```
POST /instances
```
Note: Make sure that you include the User and Organization keys in the header. See the Overview for details.
Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "campaignmonitor"
  },
  "configuration": {
    "authentication.type": "basic",
    "username": "xxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "tags": [
    "Docs"
  ],
  "name": "API Instance"
}'

Authenticate with OAuth Through API

Authenticating with OAuth 2.0 through API is a multi-step process that involves:

Getting a redirect URL. This URL sends users to the vendor to log in to their account.
Authenticating users and receiving the authorization grant code. After the user logs in, the vendor makes a callback to the specified url with an authorization grant code.
Authenticating the element instance. Using the authorization code from the vendor, authenticate with the vendor to create an element instance at Cloud Elements.

Getting a Redirect URL

Use the following API call to request a redirect URL where the user can authenticate with the API provider. Replace {keyOrId} with the element key, campaignmonitor.

curl -X GET /elements/api-v2/{keyOrId}/oauth/url?apiKey=<api_key>&apiSecret=<api_secret>&callbackUrl=<url>&siteAddress=<url>

Query Parameters

Query Parameter	Description
apiKey	The key obtained from registering your app with the provider. This is the Client ID that you recorded in API Provider Setup section.
apiSecret	The secret obtained from registering your app with the provider. This is the Client Secret that you recorded in API Provider Setup section.
callbackUrl	The URL that will receive the code from the vendor to be used to create an element instance.

Example cURL

'https://api.cloud-elements.com/elements/api-v2/elements/campaignmonitor/oauth/url?apiKey=fake_api_key&apiSecret=fake_api_secret&callbackUrl=https://www.mycoolapp.com/auth&state=campaignmonitor' \

Example Response

Use the oauthUrl in the response to allow users to authenticate with the vendor.

{
    "oauthUrl": "https://api.createsend.com/oauth?scope=ViewReports%2CManageLists%2CCreateCampaigns%2CImportSubscribers%2CSendCampaigns%2CViewSubscribersInReports%2CManageTemplates%2CAdministerPersons%2CAdministerAccount%2CViewTransactional%2CSendTransactional&response_type=code&redirect_uri=https%3A%2F%2Fhttpbin.org%2Fget&state=campaignmonitor&client_id=123456",
    "element": "campaignmonitor"
}

Authenticating Users and Receiving the Authorization Grant Code

Provide the response from the previous step to the users. After they authenticate, Campaign Monitor provides the following information in the response:

code
state

Response Parameter	Description
code	The Authorization Grant Code required by Cloud Elements to retrieve the OAuth access and refresh tokens from the endpoint.
state	A customizable identifier, typically the element key (`campaignmonitor`) .

Note: If the user denies authentication and/or authorization, there will be a query string parameter called error instead of the code parameter. In this case, your application can handle the error gracefully.

Authenticating the Element Instance

Use the /instances endpoint to authenticate with Campaign Monitor and create an element instance. If you are configuring events, see the Events section.

Note: The endpoint returns an element instance token and id upon successful completion. Retain the token and id for all subsequent requests involving this element instance.

To create an element instance:

Construct a JSON body as shown below (see Parameters):

{
  "element": {
    "key": "campaignmonitor"
  },
  "providerData": {
    "code": "<AUTHORIZATION_GRANT_CODE>"
  },
  "configuration": {
    "authentication.type": "oauth2",
    "oauth.callback.url": "<CALLBACK_URL>",
    "oauth.api.key": "<CONSUMER_KEY>",
    "oauth.api.secret": "<CONSUMER_SECRET>",
    "filter.response.nulls": true
  },
  "tags": [
    "<Add_Your_Tag>"
  ],
  "name": "<INSTANCE_NAME>"
}

Call the following, including the JSON body you constructed in the previous step:
```
POST /instances
```
Note: Make sure that you include the User and Organization keys in the header. See the Overview for details.
Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "campaignmonitor"
  },
  "providerData": {
    "code": "xoz8AFqScK2ngM04kSSM"
  },
  "configuration": {
    "authentication.type": "oauth2",
    "oauth.callback.url": "<CALLBACK_URL>",
    "oauth.api.key": "<CONSUMER_KEY>",
    "oauth.api.secret": "<CONSUMER_SECRET>"
  },
  "tags": [
    "For Docs"
  ],
  "name": "API Instance"
}'

Parameters

API parameters not shown in the Cloud Elements are in code formatting.

Note: Event related parameters are described in Events.

Parameter	Description	Data Type
'key'	The element key. campaignmonitor	string
Name `name`	The name for the element instance created during authentication.	Body
Authentication Type `authentication.type`	How you want to authenticate with the API provider, either oauth2 or basic.	string
API Key `username`	Basic Authentication only. The Campaign Monitor API Key.
`oauth.callback.url`	OAuth 2.0 Authentication only. The URL where you want to redirect users after they grant access. This is the Callback URL that you noted in the API Provider Setup section.
OAuth API Key `oauth.api.key`	OAuth 2.0 Authentication only. The Client ID from Campaign Monitor. This is the Client ID that you noted in the API Provider Setup section	string
OAuth API Secret `oauth.api.secret`	OAuth 2.0 Authentication only. The Client Secret from Campaign Monitor. This is the Client Secret that you noted in the API Provider Setup section	string
tags	Optional. User-defined tags to further identify the instance.	string

Example Response for an Authenticated Element Instance

{
  "id": 123,
  "name": "test",
  "token": "3sU/S/kZD36BaABPS7EAuSGHF+1wsthT+mvoukiE",
  "element": {
      "id": 39,
      "name": "Campaign Monitor",
      "key": "campaignmonitor",
      "description": "Campaign Monitor makes it easy for you to create, send, and optimize your email marketing campaigns.",
      "image": "https://www.campaignmonitor.com/assets/brand/campaignmonitor.jpg",
      "active": true,
      "deleted": false,
      "typeOauth": false,
      "trialAccount": false,
      "resources": [ ],
      "transformationsEnabled": true,
      "bulkDownloadEnabled": true,
      "bulkUploadEnabled": true,
      "cloneable": true,
      "extendable": false,
      "beta": true,
      "authentication": {
          "type": "oauth2"
      },
      "elementId": 3928,
      "provisionInteractions": [],
      "valid": true,
      "disabled": false,
      "maxCacheSize": 0,
      "cacheTimeToLive": 0,
      "configuration": {    },
      "eventsEnabled": false,
      "eventsNotificationCallbackUrl": "false",
      "traceLoggingEnabled": false,
      "cachingEnabled": false,
      "externalAuthentication": "none",
      "user": {
          "id": 12345
        }
    }
 }