BrightTALK Authenticate an Element

On this page

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

Authenticate Through the UI

Use the UI to authenticate with BrightTALK and create an element instance. You will need your Application Name and Application Password that you identified in BrightTALK API Provider Setup.

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 Through API

You can provision instances through Cloud Elements or through APIs. This section describes both methods and includes parameter details, a request sample, and a response sample.

Provision an Instance in Cloud Elements

Provision an Instance via API

Parameters

Request Body

Sample Response

Provision an Instance in Cloud Elements

Use Cloud Elements to provision an instance using our user interface. We provide a Provision Instance workflow that includes two steps: Provision it and Tag it.

  1. Sign in, and then search for the element in our Elements Catalog. Search
  2. Click Add Instance.
  3. Enter your Instance Name.
  4. Complete the Instance Configuration parameters. See Parameters or hover over the information icon for information about each parameter.
  5. Click Next.
  6. On the Tag It page, enter any tags that might help further define the instance.
    • To add more than one tag, click Add after each tag. Add tag
  7. Click Done.
  8. Take a look at the documentation for the element resources now available to you. Documentation Tab

Provision an Instance via API

To provision your BrightTALK Element, use the /instances API.

Note: token is returned upon successful execution of this API. Retain the token for all subsequent requests involving this element instance.

The provisioning API call includes:

  • HTTP Headers: Authorization- User , Organization
  • HTTP Verb: POST
  • Request URL: /instances
  • Request Body: Required – see below
  • Query Parameters: none

Request Body

You must include an instance.json file with your instance request. See Parameters for information about each parameter. The Boolean parameters show default values.

Note: If you don't specify a required parameter, your response results in an error.

{
  "element": {
    "key": "brighttalk"
  },
  "configuration": {
    "brighttalk.api.key":  "<INSERT_BrightTALK_KEY>",
    "brighttalk.api.secret": "<INSERT_BrightTALK_SECRET>",
    "brighttalk.isstaging": false,
    "brighttalk.bulkignore.emailnotpresent": true,
    "filter.response.nulls": true
  },
  "tags": [
    "<INSERT_TAGS>"
  ],
  "name": "<INSERT_INSTANCE_NAME>"
}

Note: Make sure that you use straight quotes in your JSON files and cURL commands. Use plain text formatting in your code and ensure that you do not include spaces in the cURL command.

Parameters

The following table shows the parameters used to provision an instance. We noted optional parameters in the table, but if you do not specify values, the element will be provisioned with default values for the optional parameters.

ParameterDescriptionData Type
Instance Name
name
The name for the instance created during provisioning.String
API Key
brighttalk.api.key
The code that identifies the calling element instance to BrightTALKString
API Secret
brighttalk.api.secret
The secret associated with the API Key that identifies the calling element instance to BrightTALKString
Staging
brighttalk.isstaging
Optional. Indicates whether the instance should connect to a production or staging environment. No or false indicates production.
Default: false
Boolean
Bulk ignore if email not present
brighttalk.bulkignore.emailnotpresent
Optional. Specifies what to do with a record during bulk download if it is missing an email . Set to Yes or true to ignore the record during download.
Default: true
Boolean
Filter null values from the response
filter.response.nulls
Optional. Determines if null values in the response JSON should be filtered from the response. Yes or true indicates that Cloud Elements will filter null values.
Default: true
Boolean
TagsOptional. User-defined tags to further identify the instance.object

Sample Request

Below is an example cURL request:

curl -X POST -H "Content-Type: application/json" -H "Authorization: User rapG956KSQJ/lZo20kdg2uurkG+wYU836miX1uQQT4k=, Organization 976c3406ee321baf50acfe6cf5eac1ac" -H "Cache-Control: no-cache" -H "Postman-Token: 5b56f6d5-e58e-d53f-a757-671f7cab58fa" -d '{
  "element": {
    "key": "brighttalk"
  },
  "configuration": {
    "brighttalk.api.key": "xxxxxx",
    "brighttalk.api.secret": "xxxxxxxxxxxxxxxxxxxxxxx",
    "brighttalk.isstaging": false,
    "brighttalk.bulkignore.emailnotpresent": true,
    "filter.response.nulls": true
  },
  "tags": [
    "Docs"
  ],
  "name": "BrightTalkforDocs"
}
' "https://api.cloud-elements.com/elements/api-v2/instances"

Sample Response

Below is an abridged successful JSON response:

{
  "id": 411183,
  "name": "BrightTalkforDocs",
  "createdDate": "2017-03-14T19:20:16Z",
  "token": "xxxxxxxxxxxxxxxxxxxxxxx=",
  "element": {
    "id": 184,
    "name": "BrightTALK",
    "hookName": "BrightTALK",
    "key": "brighttalk",
    "description": "Add an BrightTALK Instance to connect your existing BrightTALK account to the Marketing Hub, allowing you to manage your channels, subscribers, activities, etc. You will need your BrightTALK account information to add an instance.",
    "image": "https://www.brighttalk.com/resources/images/logo_b.png?v=97373",
    "active": true,
    "deleted": false,
    "typeOauth": false,
    "trialAccount": false,
    "signupURL": "http://www.brighttalk.com",
    "defaultTransformations": []
  },
  "configuration": {
   "brighttalk.api.secret": "xxxxxxxxxxxxxxxxxxxxxxx",
   "filter.response.nulls": "true",
   "brighttalk.bulkignore.emailnotpresent": "true",
   "brighttalk.isstaging": "false",
   "brighttalk.api.key": "xxxxxxxxxxxxxxxxxxxxxxx"
 }
}

Instance Configuration

The content in the configuration section or nested object in the body posted to the POST /instances or PUT /instances/{id} APIs varies depending on which element is being instantiated. However, some configuration properties are common to all elements and available to be configured for all elements. These properties are -

  • event.notification.enabled: This property is a boolean property, and determines if event reception (via webhook or polling) is enabled for the element instance. This property defaults to false.
  • event.vendor.type: When event.notification.enabled property is set to true, this property determines the mechanism to use to receive or fetch changed events from the service endpoint. The supported values are webhook and polling. Most elements support one mechanism or the other, but some like Salesforce.com support both mechanisms. This property is optional.
  • event.notification.type: This property can be used to determine how an event notification should be sent to the consumer of the element instance, in most cases your application. Currently, webhook is the only supported value for this property. This means that when an event is received by the element instance, it will get forwarded to the provided event.notification.callback.url via a webhook to you. This property is optional.
  • event.notification.callback.url: As mentioned above, the value of this property is an http or https URL to which we will post the event for consumption by your application. This property is optional.
  • filter.response.nulls: This property defaults to true, i.e., it's boolean property, and determines if null values in the response JSON should or should not be filtered from the response returned to the consuming application. By default, all null values are filtered from the response before sending the response to the consuming application.