Setup Avochato Data Sync and Avochato API Credentials for Salesforce

Connect Avochato to Salesforce and enable the data sync and other power features via the API

Want to get your data sync and Avochato API credentials enabled right away? You came to the right place!

A. Enable Data Sync

To enable the data sync from Avochato to your Salesforce org, follow these simple steps:

  1. Ensure the Avochato for Salesforce managed package is installed in your Salesforce org. If you’re unsure, visit the Avochato for Salesforce listing on the AppExchange and install it on your org
    1. If you’re installing this for the first time in a non-sandbox org, it’ll start a 14 day trial with our Avochato for Salesforce package
    2. If you install the package onto a Sandbox org, you have unlimited time with the Avochato for Salesforce package to test to your heart’s content!
  1. Within Avochato, click on the “Integrations” menu option. Now you can connect Avochato to your Salesforce Org of choice. Use “Connect Production” if you’re ready to go live with the sync, or “Connect Sandbox” if you’re in the testing phase. If you see the “Settings” button, it means you’re already connected and good to go
    1. For details about how the data sync works, what fields are synced, and customization options, see our main page below:
      1. Notion image

B. Sync Avochato API Credentials to Salesforce

1. Default API Credentials

In order to use certain power features in Salesforce, like List View Broadcasting and Flow Avochato actions, you need to sync the Avochato API credentials to Salesforce.

Use the following steps to sync the API credentials to Salesforce:

  1. Ensure the Avochato Data Sync is enabled. Refer to section A above and make sure you’re Avochato Inbox is connected to Salesforce.
  1. Through the Avochato left sidebar menu, go to Avochato → Settings → API Access, and select the user you’d like to use as your default API user.
    1. Whatever Avochato accounts / inboxes that user has access to in Avochato will be the access they have when sending messages from Flow builder or List View Broadcasting. Select the Avochato user that is connected to most or all of your Avochato inboxes.
    2. When you click “Generate Credentials” button, it automatically syncs them to Salesforce, enabling features like List View Broadcasting and Flow Builder Avochato API actions.
Notion image

Yay! API Keys FTW! Save the Auth ID and Auth Secret somewhere safe - the secret will not be given to you again 🤫

To verify that your Avochato API credentials were successfully saved into Salesforce, do the following:

  1. Through the Salesforce UI, go to Setup → Custom Metadata Types, and click on the Manage Records link next to “Avochato Credentials”
  1. You should see one or more rows of credential records. Click into the row that has the “Is Default” checkbox selected
  1. Within that credential metadata record, you should the “Is Active” checkbox marked true as well, and the “Auth Secret” should look like a very long string of random characters.
    1. 🤔
      If that string is less than 20 characters, then it wasn’t encoded properly, and you may need to attempt to sync your Salesforce credentials again using the steps at the start of this article

2. User-specific API Credentials

You can sync user-specific Avochato API credentials to Salesforce, so that you can pin-point message attribution per Avochato user, and also ensure the Salesforce user is only able to send messages from the Avochato inboxes they have access to.

Before proceeding, ensure that the Salesforce User Email and Avochato User Email match each other exactly. If the emails don’t match, then we won’t be able to link the Avochato user’s API credentials to the right Salesforce User.

The process is relatively painless, and here's what to do:

  1. For each Avochato User, navigate into that Avochato user's main inbox to generate the API credentials for that inbox
    1. This will become that specific user’s default inbox within Salesforce, but will still have access to send on behalf of the other Avochato inboxes they’re associated with
  1. Ensure that Avochato Inbox has the Salesforce data sync enabled (i.e. it was connected to SF production, and you can see the "Settings" button with the Integrations → Salesforce section)
  1. Within that inbox, click on Settings → API Access
  1. Click the dropdown box of users, and choose the Avochato User of interest, then click Generate Credentials
  1. That should automatically sync that Avo user's API credentials to Salesforce (yay!). You can check the Salesforce Setup → Custom Metadata Types → Avochato Credentials (manage records) and see those user API credentials synced over

To confirm the API credentials synced properly per user, go to Setup → Custom Metadata Types (MDT), and click on the Manage Records link next to “Avochato Credentials”. Within the data table, you should see the Salesforce User Id column populated with a Salesforce record Id (either 15 or 18 characters long).

Notion image


If the Salesforce User Id is blank, it means the credentials synced over to Salesforce, but it didn’t find the right Salesforce user to associate to (usually because the user email didn’t match between the two platforms).

Ensure the Salesforce and Avochato user emails match each other from both platforms, and then try generating new API credentials for that user. If you know which API credential belongs to the right Salesforce user, you can copy and paste over that Salesforce User’s Id into the MDT record and save. The Salesforce User Id is the main identifier of the Avochato API credential throughout our power features in Salesforce

Did this answer your question?