BrightTALK Authenticate an Element Instance

Last Modified on 02/01/2019 10:06 am MST

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 BrightTALK username (entered in the API Key field) and password (entered in the API Secret field).

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.

Parameter

Description

Data Type

Instance Namename

The name for the instance created during provisioning.

String

API Keybrighttalk.api.key

The code that identifies the calling element instance to BrightTALK. This is your BrightTALK username.

String

API Secretbrighttalk.api.secret

The secret associated with the API Key that identifies the calling element instance to BrightTALK. This is your BrightTALK password.

String

Stagingbrighttalk.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 presentbrighttalk.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 responsefilter.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

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.