Try our new AI Activity Summarizer Learn More

How Can We Help?
< All Topics
Print

How to set up your OpenAI API key for the Activity Summarizer

Posted
Updated
ByBen Sterne

This article is for Match My Email customers setting up their OpenAI API key for the Activity Summarizer. Setup is easy and takes just a few minutes.

We designed our Activity Summarizer so customers can connect their org directly to OpenAI.
This is for a few important reasons:

  • It’s easy to connect to the OpenAI: OpenAI makes it so anyone can set this up in just a few minutes.
  • You pay the cheapest rate possible: You do not pay for your AI usage through us so you know you are paying the lowest possible rate. Unlike Agentforce.
  • Your data does not pass through our system: Your data goes directly from your Salesforce org to OpenAI via Salesforce’s secure Named Credential connection. We have no access to your data or API key when you use our Activity Summarizer.

 

Set up your OpenAI API key with OpenAI (Part 1/4)

At the end of these steps you will have connected a credit card to OpenAI, added a small amount of credits, and get your API key.

We recommend starting with $20 of AI credits which should be plenty to get your Activity Summarizer going.

  1. Create an OpenAI platform account here: https://platform.openai.com/
  2. Add a payment method and initial credits.
    • Go to settings icon (top right) → Billing →Add payment details
    • When asked for an initial credit purchase, add as little as $5 but we recommend $20 to get going.
  3. Configure your monthly budget.
    • Go to Limits (also in Settings) → Edit Budget
    • Set the budget limit to your liking. It depends on org size and usage but we reconned $20 monthly budget as OpenAI will alert you if you approach your limit.
  4. Create an API key.
    • Go to API keys (also in Settings) → + Create new secret key
    • Name the key whatever you want.
    • For most limited permissions: set Model Capabilities access to “Request” and Responses access to “Write
    • Once you get your API key, keep it in a safe secret place.

 

Example of most limited permissions for OpenAI API Key

 

Optional: Turn off API Call Logging (Part 2/4)

To ensure none of the data sent through the API is stored with OpenAI:

  1. Got to settings icon (top right) → Data Controls → Data retention tab
  2. Under “API Call Logging”, select “Disabled”
  3. Click “Save”

Add your API key to your Salesforce Org (Part 3/4)

Before adding your API key from OpenAI into Salesforce. You need to check how your activities roll up to Accounts in your Salesforce Org.

  1. In your Salesforce Org go to Setup
  2. Use the Quick Find to get to “Activity Settings”
  3. See if “Roll up activities to a contact’s primary account” is checked.

 

  1. In the top left, click on the app launcher, use search to open “Match My Email Setup”

 

  1. On the menu on the left, go to AI Settings
  2. Ensure Activity Roll Up Configuration is set correctly given your organization’s configuration.

 

Once you have your API key, all you need to do is add your API key to your Salesforce Org so you can start using your Activity Summarizer.

Named credentials and now external credentials allow for secure authenticated API callouts: Learn more here.

This means Match My Email can make API calls on your behalf without ever seeing or storing your actual API key.

  1. In your Salesforce Org go to Setup
  2. Use the Quick Find to get to “Named Credentials”
  3. Go to the “External Credentials” tab on the “Named Credentials” page.
    DO NOT CLICK “OpenAI_API”, that is a the wrong credential to update.

  1. Open external credential named “OpenAI_API_Key”

  1. Scroll down the page to the “Custom Headers” section and click “New”.

  1. Add a custom header, with the name “Authorization” and a value of “Bearer your-api-key-from-openai”. Instead of “your-api-key-from-openai”, put your actual api key.

  1. Click “Save”

 

NOTE: Match My Email recommends you rotate (set a new API key) for the Activity Summarizer at least once a year as a data security best practice.

Configure permissions for your Salesforce org (Part 3/4 Continued)

Once your OpenAI API key is setup in Named Credentials, the last step is to configure permissions for your users to use the AI summarizer.

MME offers two permission sets for our AI summarizer:

  • MME AI Generation Access: This permission set allows users to view AND generate summaries(click “Summarize”).
  • MME AI View Access: This permission set allows users to view summaries ONLY (not click “Summarize”

 

Assign the permission set for view access:

  1. In your Salesforce Org go to Setup
  2. Use the Quick Find to get to “Permission Sets”
  3. Click on “M” and open “MME AI View Access”

  1. Click “Manage Assignments”
  2. Click “Add Assignment”
  3. Assign users who you’d like to have access the Summarizer

 

To assign the permission set for summary generation access:

  1. repeat steps 1-6 for “MME AI Generation Access”

Add Activity Summarizer to record pages (Part 4/4)

Your Activity Summarizer is ready to be used!

  1. Go to the page of a Contact, Lead, Account or Opportunity and under the gear icon, click “Edit Page”

  1. In Lightning App Builder, on the components tab on the left, scroll down to the “Custom” section.
  1. Click and drag the “Activity Summarizer” component anywhere you want on the page.

  1. Click “Save”.
  2. Click “Activation” and activate the changes.
  3. Refresh the record page you have updated.

 

You are all set! We hope your team saves lots of time summarizing your activities!