How to: Configure Inbound Registration with Salesforce

The Brandlive Platform’s inbound registration integration allows you to host registration for your webinar or event via a CRM like Salesforce. Host registration with a Salesforce form that will automatically sync to your Brandlive Platform webinar log-in system, enabling seamless access for your attendees without needing registration to originate from Brandlive.

Important Note

  • All fields have a 50-character limit. if the limit is exceeded this will result in an error
  • We are offering an endpoint to map the registration fields to, from a third party app. In response to you sending the registration data to Brandlive, Brandlive returns a confirmation URL. From there, the customization options are up to your discretion depending on your intended use.
  • Once configured, this integration will successfully dispatch a Brandlive registration confirmation email upon attendee registration through your external form. To customize this, please see our article on customizing registration emails
  • If at any point in your setup you run into issues, please reach out to your Brandlive Account Manager or email us at support@brandlive.com.

Authentication Process

  1. From the Brandlive Platform Projects dashboard, select “Settings” from the top navigation.
  2. In Settings, navigate to the “API Keys” tab on the left hand panel. To generate your token, click “Create New API Key.” A spreadsheet will download containing your secret and API key. If lost, the secret cannot be recovered, so store the credentials in a safe place.

  1. In the spreadsheet, add a new row and type "Basic." Then add a space after "Basic". Copy and paste the key and secret separate by a colon, for example:
    "Basic key:secret"
    This is will be used for authorization later in the Salesforce header.
  2. Then return to the Projects dashboard and select the Project you are trying to configure your integration for. Navigate to the Integrations tab of the Project Details page.

  1. After selecting “edit” on the CRM tile of your choice, copy both API endpoint and payload information from the popout.

Screen Shot 2023-08-31 at 11.09.29 AM.png

5. To avoid any conflicts with other integrations you have configured, toggle “Disable Native Registration” ON and input your third-party hosted form address into the field that appears. Click Save and then enter the Sitebuilder to publish your project.

6. Now, consider which of the below configurations best meets your project's needs.

Basic Configuration

  1. Create a custom Campaign property in your Salesforce account and make note of the “Field Name” as this will be needed in a later step. This can be done by going to Setup, then Object Manager, then Campaign, then Fields and Relationships, and finally, New.This will be the field that houses the Brandlive Event ID for your Projects. 
  2. In Brandlive, go to Settings, click Integrations and then filter to Inbound. Select “Edit Configuration” on the Salesforce Inbound Tile.
  3. In the window you are taken to, authenticate your Salesforce Account and click “Next.”
  4. In the next screen, enter the Brandlive API Key, Secret, and Field Name that you set up earlier. Click “Next” and toggle on the Integration Tile you selected in step 2. 
  5. A new Outbound Message and Flow will automatically be created and activated in your Salesforce Account named TrayOnCampaignMemberCreate_XXXX. You may then go into the Flow and add any extra conditions to the Trigger if needed.
  6. Within Brandlive, select the Project you are trying to configure your integration for. Navigate to the Integrations tab of the Project Details page and click "Edit" on the Inbound Integration tile.

  7. To avoid any conflicts with other integrations you have configured, toggle “Disable Native Registration” ON and input your third-party hosted form address into the field that appears. Click Save and then enter the Sitebuilder to publish your project.

Screen Shot 2023-08-31 at 11.09.29 AM.png

8. Copy the value within "Target". This is the Brandlive event Identifier that will be entered into your Salesforce Campaign.

9. In your Campaign, enter the Brandlive Event ID into the newly created “target” field that was created earlier. This will tell Brandlive which Project to register the campaign member for.Screenshot 2023-08-31 at 11.52.47 AM.png

10. You are done! Brandlive will now automatically register your newly created campaign members and map their First Name, Last Name, Company, Title, and Event ID.

Advanced Configuration

  1. In Salesforce, navigate to the Setup view by clicking on the gear icon in the header and selecting Setup.
  2. In the Quick Find search bar, search for Named Credentials, and select it.
  3. Select the External Credentials tab and select New to create a new external credential.
  4. In the Label input, enter Http Callout Post External Credential and in the Name input, enter HttpCalloutPostExternalCredential. For authentication protocol select Custom and click Save.
  5. Scroll down to the Principals section and select New.
  6. For parameter name, use Http Callout Post Principal, sequence number 1, and select Save.
  7. In the Quick Find search bar, search for Permission Sets and select it.
  8. Select New, in the label enter Http Post Callout Permission Set, the api name will autofill, and then select Save.
  9. Scroll down to and select the option External Credential Principal Access. Then select Edit.
  10. In the Available External Credential Principals list, select HttpCalloutPostExternalCredential and then select Add to move it to the Enabled External Credential Principals list, and select Save.
  11. Select Manage Assignments, Add Assignment, and then select the checkbox next to the desired user account, followed by Next and Assign.
  12. Search for Named Credentials again in the Quick Find search bar, and select New to create a new named credential. (Note that we created an external credential before, not a named credential)
  13. In the Label field, enter Http Callout Post Named Credential and HttpCalloutPostNameCredential in the Name field.
  14. In the URL field, enter https://api-hv.brandlive.com/inbound-registration/salesforce 
  15. In the External Credential dropdown, select  Http Callout Post External Credential, uncheck the Generate Authorization Header option, and select Save.
  16. Scroll down to the Custom Headers section and select New.
  17. Type Authorization into the Name field, and your token into the value field (Basic <key>:<secret>)
  18. Sequence number should be set to 1, and then select Save.
  19. Search for Flows in the Quick Find search bar.
  20. Select New Flow, then Record Trigger, and Create.
  21. Between the Start and End nodes, select the plus symbol and add an Action element.
  22. In the modal, select the Create Http Callout option, name this HttpCalloutPostService, and select Http Callout Post Named Credential from the Named Credential dropdown. (You should see the url you entered previously appear below the URL label)
  23. In the next modal, enter Http Callout Post Action into the label field, select Post from the Method dropdown, and leave the URL Path field blank.
  24. In the Provide Sample Request section, select new and then copy the following into the text box for review:
    {
       "target": "00000000-0000-0000-0000-000000000000",
       "email_address": "<user's email address>",
       "first_name": "<user's first name>",
       "last_name": "<user's last name>",
       "company": "<user's company>",
       "title": "<user's job title address>"
    }
  25. Select Review, and then select Done.
  26. Select New for the Sample Response section, and enter the following as you did for the request.
    {
      "link": "https://event-link.com"
    }
  27. Select Review and then Done.
  28. Select Save.
  29. Enter Http Callout Post Action Element into the label field for the new action and the API anime will be auto generated.
  30. In the Body dropdown, select New Resource, and then select Variable for the Resource type, ActionBodyVar for the API Name, and Apex-Defined for the Data type.
  31. For the Apex Class field, select the option ExternalService__HttpCalloutPostService_Httpx20Calloutx20Postx20Action_IN_body, then select Done.
  32. Back in the flow, select the plus symbol before the Action element you just created, and add an Assignment element.
  33. In the label, add Action Body Variable Values.
  34. In the Search variables field, select ActionBodyVar under Apex-DefineVariables, and then another dropdown appears to choose and edit your fields. Operator should be set to Equals. These values should be manually entered, and will be the identifier for the project. This can be found by navigating to the project details page in the Brandlive Platform, in the Integrations section, in the Salesforce inbound integration tile.
  35. ActionBodyVar > target > equals < [target value from integration tile]
  36. You can then set the rest of the Variable Values that were defined in the Request Sample earlier. These will likely be dynamic values gathered from user data. For example:
    ActionBodyVar > firstx5fname > equals <user's first name>
    ActionBodyVar > lastx5fname > equals <user's last name>
    Etc. according to the fields in the payload template
  37. Select Done, and then Save. Name the Flow Label Http Callout Post Action and then select Save again.
  38. Select Debug and Run in the new tab that is opened.
Top