Jump to a Section

Overview

Note: With Salesforce, you can only authorize a maximum of 5 accounts.

To get started, select a Salesforce Event from the Channels menu in the right-hand sidebar of the Designer or find Salesforce within the Create Account button in your Account Settings window.

  1. First, enter a nickname for your account in the Account Nickname field. The nickname can be anything - the actual name of the account, a Salesforce username, or a generic nickname.
  2. Select the environment of your Salesforce account. Most accounts will be in a production environment unless you know specifically that you are using a sandbox account.
  3. Enter your Salesforce email and password information in the OAuth window that opens. If you are already logged into Salesforce in another window, this step will be skipped automatically. NOTE: If you have a custom Salesforce domain, you need to first click the Use Custom Domain link in the bottom right of the popup window. A custom Salesforce domain is something like yourcompany.mysalesforce.com. If you do have a custom domain, enter the domain (yourcompany) into the Custom Domain field in this second window, click Continue, and then proceed through the rest of the steps listed below.
  4. Next, you will be asked if you want to authorize access to your Salesforce account. Click Allow at the bottom of the window.
  5. When confirmed, the card Options will show the Salesforce Record types available to use in your FLO.

Once you create an account configuration on one Salesforce card, you can use the same configuration every time you create a Salesforce FLO. You can also create multiple configurations for each Connector to link all your accounts and manage them from your Settings page.

Are you looking for Gainsight help? Click here.

  • Salesforce

    General

    For information on specific errors being returned from the Salesforce API, see the Salesforce API docs. You can also check the status of the Salesforce API for any possible service outages.

    Note: you might receive generic errors such as “Bad Request” from certain connectors, like Salesforce. Often, the actual error message is contained within the object that is returned by the API.

    Authentication

    Having difficulties connecting to your Salesforce account? Try reauthorizing your account in Settings –> Accounts, or deleting the account and adding it again.

    You can find a list of all your available accounts under Settings –> Accounts.

    We are constantly aggregating more data about errors, so if this article doesn’t help solve your problem, check back soon.

Events

  • Field Updated

    Start a FLO when an existing record is updated.

    Note:

    • This monitor can’t monitor for the field “Owner_ID” on ANY record type. Salesforce’s API does not record when or if owner ID is changed within the system, and therefore doesn’t tell the monitor to fire.
    • This monitor will only include the most recent change made on a field. For example if a field is updated five times within the polling period, there will only be one execution with the most recent update in the field output.
    • The field you choose must be history enabled within Salesforce. To check if a field is history enabled or to make it so, first go to ‘Setup’ within your Salesforce instance. Click ‘Customize’ under Build and select the record type you will be monitoring. Select ‘Add a custom field’. Click ‘Set History Tracking’. (You will need to be an administrator to make these changes).

    Options

    • Record Type (dropdown list): A dynamically generated list of record types including custom objects.
    • Field (dropdown list): A list of writable fields generated from your Record Type selection above. Includes custom fields within Salesforce.

    Output Fields

    Record

    • A dynamically generated list of readable fields from your Salesforce Account.

    Field History

    • Old Value (text): The previous value of the value before it was changed.
    • New Value (text): The new (current) value of the field.

    Context

    • Execution ID (text): The unique ID for the execution that updated the record.
  • New Record

    Start a FLO when a new record of a certain type is created.

    Options

    • Record Type (dropdown list): A dynamically generated list of record types from your Salesforce account. Includes custom objects. info on record types.

    Output Fields

    Record fields are dependent on the Record Type dropdown list.

    • Record
      • A dynamically generated list of fields from your Salesforce account. This expansive list includes nearly all information present on the type of record selected. information on the possible fields.
    • Context
      • Execution ID (text): The execution Id for the new record.
  • Outbound Message

    Start a FLO when a Salesforce Outbound Message is triggered.

    NOTE: This requires additional setup in your Salesforce instance. See below for directions.

    Options

    • Record Type (dropdown list): A dynamically generated list of Record types from your Salesforce account.info on record types.

    Output Fields

    Context

    • Execution ID (text): The ID for the action within Salesforce that you selected in the Record Type dropdown list.

    Salesforce Outbound Message Setup Go to the Salesforce setup page. To access the setup page, locate and click the button labeled “setup” in the top right hand corner of the Salesforce account. From the Salesforce setup page, locate the “Quick Find / Search” bar on the left hand side. Search for “Workflow Rules” and then follow these steps:

    1. Click the “Workflow Rules” button. This will take you to the Workflow Rules page.

    2. Click the “New Rule” button and select the object type the rule will apply to (e.g. “Opportunity” if you are monitoring new/updates to Opportunity records). Click the “Next” button.

    3. Set a rule name, evaluation criteria and rule criteria. Click the “Save & Next” Button.

    4. Click the “Done” Button.

    5. From the newly created Workflow rule, select the “Edit” button.

    6. From the “Add Workflow Action” dropdown select “New Outbound Message”. Specify name, description, Endpoint URL, and fields to include in the new outbound message. When done, click on the “Save” button.

      1. “Endpoint URL” field will contain the URL provided on the Salesforce Outbound Message card in Azuqua. Setup a FLO beginning with the Outbound Message event card. Click the “</>” icon in the bottom right and copy the provided URL.
    7. Return to the Workflow Rules page, locate the newly created rule and click “Activate”.

  • Record Deleted

    Start a FLO when a record of a specified type is deleted.

    Options

    • Record Type (dropdown list): A dynamically generated list of record types from your Salesforce account. Includes custom objects.info on record types.

    Output Fields

    • Record
      • Record ID (text): The ID for the deleted record within Salesforce.
      • Time Deleted (date): The date and time a record of the specified type was deleted.
    • Context
      • Execution ID (text): The execution ID for the action within Salesforce.
  • Record Updated

    Start a FLO when an existing record is updated.

    Options

    • Record Type (dropdown list): The type of record you want to monitor for changes. This list is dynamically generated from your Salesforce account. Includes custom objects. info on record types.

    Output Fields

    Context

    • Execution ID (text): The ID for the action within Salesforce that you selected in the Record Type dropdown list.
  • Monitor

    Monitor

    Monitors Salesforce for new or updated records of the type you choose.

    Note: we do not recommend using the “Test” functionality on Salesforce monitors or you will run the risk of missing records. This is because the monitor is delayed by up to 15 minutes, meaning if a record is changed at 3:05pm, the monitor will not pick it up until 3:20pm. (The designer’s normal polling frequency is 5 minutes). This delay is required in order to ensure all records are picked up, and is particular to Salesforce because they have an eventually consistent API and records that are created in the system aren’t immediately available in the API.

    Are you looking for Gainsight help? Click here.

    Options

    • Record type (dropdown): a dropdown of your available record types in Salesforce, including custom records

    Output Fields

    The output fields are dynamically generated and will reflect the fields that are available in your Salesforce instance for that record type. NOTE: Any field with _c at the end is a custom field. Here are some standard fields that you may see as outputs on your monitor:

    fields 

    • Id (number): the unique identifier in Salesforce of the record that was created or updated. NOTE: This field must be selected and showing on your card in order for your FLO to work.
    • IsDeleted_ (boolean):_ returns true if the record has been deleted and false if it is still active
    • IsPrivate_ (boolean):_ returns true if the record is private and false if it is public
    • Name_ (text):_ name of the record that was created or updated
    • CreatedDate_ (timestamp):_ the day and time at which the record was created given in UTC format within the timezone of your Salesforce instance
  • MonitorChanged

    Monitor Changed

    Monitors Salesforce for updated records of the type you choose.

    Note: we do not recommend using the “Test” functionality on Salesforce monitors or you will run the risk of missing records. This is because the Monitor Changed trigger is delayed by up to 15 minutes, meaning if a record is changed at 3:05pm, the monitor will not pick it up until 3:20pm. (The designer’s normal polling frequency is 5 minutes). This delay is required in order to ensure all records are picked up, and is particular to Salesforce because they have an eventually consistent API and records that are created in the system aren’t immediately available in the API.

    Are you looking for Gainsight help? Click here.

    Options

    • Record type (dropdown): a dropdown of your available record types in Salesforce, including custom records

    Output Fields

    The output fields are dynamically generated and will reflect the fields that are available in your Salesforce instance for that record type. NOTE: Any field with _c at the end is a custom field. Here are some standard fields that you may see as outputs on your monitor:

    fields 

    • Id (number): the unique identifier in Salesforce of the record that was updated. NOTE: This field must be selected and showing on your card in order for your FLO to work.
    • IsDeleted_ (boolean):_ returns true if the record has been deleted and false if it is still active
    • IsPrivate_ (boolean):_ returns true if the record is private and false if it is public
    • Name_ (text):_ name of the record that was updated
    • CreatedDate_ (timestamp):_ the day and time at which the record was created given in UTC format within the timezone of your Salesforce instance
  • MonitorNew

    Monitor New

    Monitors Salesforce for new records of the type you choose.

    Note: we do not recommend using the “Test” functionality on Salesforce monitors or you will run the risk of missing records. This is because the Monitor New trigger is delayed by up to 15 minutes, meaning if a record is created at 3:05pm, the monitor will not pick it up until 3:20pm. (The designer’s normal polling frequency is 5 minutes). This delay is required in order to ensure all records are picked up, and is particular to Salesforce because they have an eventually consistent API and records that are created in the system aren’t immediately available in the API.

    Are you looking for Gainsight help? Click here.

    Options

    • Record type (dropdown): a dropdown of your available record types in Salesforce, including custom records

    Output Fields

    The output fields are dynamically generated and will reflect the fields that are available in your Salesforce instance for that record type. NOTE: Any field with _c at the end is a custom field. Here are some standard fields that you may see as outputs on your monitor:

    fields

    • Id (number): the unique identifier in Salesforce of the record that was created. NOTE: This field must be selected and showing on your card in order for your FLO to work.
    • IsDeleted_ (boolean):_ returns true if the record has been deleted and false if it is still active
    • IsPrivate_ (boolean):_ returns true if the record is private and false if it is public
    • Name_ (text):_ name of the record that was created
    • CreatedDate_ (timestamp):_ the day and time at which the record was created given in UTC format within the timezone of your Salesforce instance
  • UpdatedField

    Updated Field

    Monitors Salesforce for when one field within one record is changed.

    Note: this monitor can’t monitor for the field “Owner_ID” on ANY record type. Salesforce’s API does not record when or if owner ID is changed within the system, and therefore doesn’t tell the monitor to fire.

    Are you looking for Gainsight help? Click here.

    Options

    • Record type (dropdown): a dropdown of your available record types in Salesforce, including custom records
    • Field (dropdown): a dropdown of your available fields to monitor within the record you chose. NOTE: The field you choose must be history enabled within Salesforce. To check if a field is history enabled or to make it so, first go to ‘Setup’ within your Salesforce instance. Click ‘Customize’ under Build and select the record type you will be monitoring. Select ‘Add a custom field’. Click ‘Set History Tracking’. (You will need to be an administrator to make any changes). NOTE: Although it will appear in your options dropdown, this monitor will not trigger if you select the field “Owner_ID”.
    • Is this a lookup field? (yes/no): Lookup fields can be identified in Salesforce as the fields with the looking glass next to them. Lookup fields trigger this monitor twice, and so they are handled in a special way compared with any other type of field. NOTE: if you select “yes” on this option, it will not pick up all records if you try to bulk update this record type and field in Salesforce. It only picks up one record every second, so in a bulk update situation only one record will be passed through the FLO out of the entire set of records you update. Bulk updating records will work for non-lookup fields.

    Output Fields

    History

    • OldValue (text): The value of the field before it was changed

    Fields

    The output fields are dynamically generated and will reflect the fields that are available in your Salesforce instance for that record type. NOTE: Any field with _c at the end is a custom field. Here are some standard fields that you may see as outputs on your monitor:

    • Id (number): the unique identifier in Salesforce of the record on which the field was updated. NOTE: This field must be selected and showing on your card in order for your FLO to work.
    • IsDeleted_ (boolean):_ returns true if the record has been deleted and false if it is still active
    • IsPrivate_ (boolean):_ returns true if the record is private and false if it is public
    • Name_ (text):_ name of the record that was updated
    • CreatedDate_ (timestamp):_ the day and time at which the record was created given in UTC format within the timezone of your Salesforce instance.

Actions

  • Build Record Object

    This action builds a single Record Object to be used with the “Create Multiple Records” Action.

    Options

    • Record Type (dropdown list): a list of all the record types available in your Salesforce account. info on record types.

    Input Fields

    Output Fields

    • Record Object (object): the generated Salesforce object, based on the input fields supplied.
  • Create Multiple Records

    Creates multiple records inside Salesforce. This card is most easily used in conjunction with the “Build Record Object” Salesforce action, as well as the List - Construct function.

    For example, to use the Create Multiple Records card:

    1. Place any number of Build Record Object Cards into your FLO. (Click here to read more on the Build Record Object action.)
    2. Add the List - Construct function. (Click here to read more on List)
    3. Drag the outputs from your Build Record Object cards into the input field section on the List - Construct card.

    Input Fields

    The input for this card is a List made up of Record Objects from the Build Record Object Action.

    • Input
      • Record Objects (list): a list of objects that contain all the records to be created inside Salesforce.

    Output Fields

    • New Records
      • Record IDs (list): New record IDs are identified by their JSON.
  • Create Record

    Creates a new Record within Salesforce.

    Options

    • Record Type (dropdown list): A dynamically generated list of record types from your Salesforce account.

    Input Fields

    The input fields are dependent on the “Record Type” dropdown list, and are dynamically generated at design time based on the type of record you want to create. Custom fields are supported. NOTE: Multi-select picklist custom fields should be entered as a semicolon-delimited list of text, e.g. “Labradoodle;Corgi;Bernese Mountain Dog”. To read the available picklist options as part of your FLO, use the Read Picklist Values action.

    Output Fields

    • Record Id (text): The record Id for the new record within Salesforce.
  • Download Attachment

    Download an attachment from a Salesforce record.

    Input Fields

    • Attachment
      • Attachment ID (text): The Salesforce ID for the attachment you wish to download.

    Output Fields

    The download behavior for the attachment will be dependent on your File Upload and Download Security settings within Salesforce.

    • File
      • Size (number): The size of the file you downloaded.
      • File Content (file): The file that you downloaded.
      • Name (text): The name of the file you downloaded.
      • Extension (type): The file format (e.g. .html, .http, etc.).
  • Download Document

    Download a Docuemnt

  • Download Document using Content Document Id

    Download a Document using a Content Document Id.

    Input Fields

    • Content Document Id
      • Content Document Id (text): The Content Document Id of the Document you wish to download.

    Output Fields

    The download behavior for the attachment will be dependent on your File Upload and Download Security settings within Salesforce.

    • File
      • Size (number): The size of the file you downloaded in bytes.
      • File Content (file): The file that you downloaded.
      • Name (text): The name of the file you downloaded.
      • Extension (type): The file format (e.g. .html, .http, etc.).
  • Dynamic Auth Custom API Action

    Make a custom API request to the Salesforce API with dynamic authentication

  • Execute Query

    Executes a SOQL query.

    Input Fields

    • SOQL Query (text): avalid SOQL query.

    Output Fields

    • Records (list): a list of of records, as specified by the SOQL query.
    • Next Page URL (text): when an SOQL Query exceeds 2,000 records (in most cases), this URL is the link to the next set of records. Note: The HTTP Request card can be used to make a follow-up request with the Next Page URL.  Previously, in Salesforce version 1.3.65, this was handled through the Execute Query card internally.  In cards versions later than 1.3.65, this functionality was altered to improve overall performance and reliability of FLOs.
  • Find Record

    Find a single record that matches the provided fields and returns that record ID.

    Options

    • Record Type (dropdown list): A dynamically generated list of record types, including custom objects.

    Input Fields

    A list of dynamically generated fields from your Salesforce account based on the record type chosen.

    Output Fields

    • Record ID (text): The record ID for the object that matches the specified fields within Salesforce.
  • HTTP Request

    Make an authenticated HTTP request to the Salesforce API

  • Read Picklist Values

    Read the option values from a picklist-type field.

  • Read Record

    Reads dynamically generated fields from an existing record of the specified Record Type.

    Search Options

    • Record Type (dropdown list): A dynamically generated list of Record types from your Salesforce account.

    Input Fields

    • Read
      • Record ID (text): The ID for the record of the specified type within Salesforce.

    Output Fields

    • Record
      • The output fields for this Action are dynamically generated from your Salesforce account. Includes custom fields. NOTE: Multi-select picklist custom fields will be returned as a semicolon-delimited list of text, e.g. “Labradoodle;Corgi;Bernese Mountain Dog”.
  • Read Related Records

    Reads the related records of a record using record id.

    Options

    • Record Type (dropdown list): the type of Salesforce record you want to perform the Read Related Records upon.
    • Relationship Field (dropdown list): the field containing an association to the related records.

    Input Fields

    • Record ID (text): the unique id associated with the record inside Salesforce.

    Output Fields

    • Related Records
      • Records (list): a list of the related records.
  • Search Records

    Searches for multiple records in the provided fields and returns the record IDs.

    Options

    • Record Type (dropdown list): the type of Salesforce record you wish to perform the action upon.

    Input Fields

    • Fields
      • A dynamically generated list of input fields based on the Record Type you selected in Options.

    Output Fields

    • Record IDs (list): a list of all associated record ids.
  • Update Custom Picklist Values

    Update the option values from a custom picklist-type field

  • Update Global Picklist Values

    Update the option values from a global picklist-type field

  • Update Record

    Update a single record identified by the record ID.

    Options

    • Record Type (dropdown list): A dynamically generated list of record types from your Salesforce account.

    Input Fields

    The input fields for this Action are dynamically generated from your Salesforce Account and dependent on the Record Type dropdown list in Options.

    • Update 
      • Record ID (text): the id of the record inside Salesforce. This is a required field.
    • Record
      • These input fields are dependent on the “Record Type” dropdown list, and are dynamically generated at design time based on the type of record you want to create. Custom fields are supported. NOTE: Multi-select picklist custom fields should be entered as a semicolon-delimited list of text, e.g. “Labradoodle;Corgi;Bernese Mountain Dog”. To read the available picklist options as part of your FLO, use the Read Picklist Values action.

    Output Fields

    No outputs available.

    More information about Update Record from Salesforce here

  • Upload Attachment

    Upload a file and attach it to a record within Salesforce.

    Input Fields

    • Attach to
      • Record ID (text): The ID for the record you wish to upload an attachment to within Salesforce.
    • File
      • Name (text): The name of the attachment you wish to upload.
      • Description (text): A description of the attachment.
      • File Content (file): The attachment you wish to upload.

    Output Fields

    • Attachment
      • Attachment ID (text): The object ID for the attachment within Salesforce.
  • Upload Document

    Uploads a document

  • Create

    Create

    Creates a new record in Salesforce of the type you choose.

    Are you looking for Gainsight help? Click here.

    Options

    • Record type (dropdown): a dropdown of your available record types in Salesforce, including custom records

    Input Fields

    Input fields are dynamically generated and will reflect the fields that are available in your Salesforce instance for that record type. Any field with _c at the end is a custom field. NOTE: for any date field you are writing to in this action, it must be in standard UTC format. The Salesforce API will automatically convert it to the timezone of your instance.

    Here are some standard fields that you may see as inputs on your card:

    fields 

    • ParentId (number): the unique identifier of the parent record in Salesforce to which you want to associate this new record
    • Name (text): name of the record that you are creating
    • Type (picklist): the category of the record you are creating, represented in your Salesforce instance as a dropdown menu. NOTE: You can write any value to this field, but we recommend matching the exact spelling and capitalization to the available dropdown options to ensure consistency across your records
    • OwnerId (number): the unique identifier of the owner of the record you are creating. You can search for a particular owner’s ID by using the Salesforce Search action and selecting “User” as the record type

    Output Fields

    data 

    • id (number): the unique identifier in Salesforce of the record that was created
  • Read

    Read

    Reads a record in Salesforce by ID and returns all the data associated with that record. Are you looking for Gainsight help? Click here.

    Options

    • Record type (dropdown): a dropdown of your available record types in Salesforce, including custom records

    Input Fields

    record

    • id (number): the unique identifer of the record you wish to read. NOTE: This is a required field and must be the ID from Salesforce for that record. We recommend using Search to dynamically find the ID of the record if it is not recorded elsewhere in your systems.

    Output Fields

    Output fields are dynamically generated and will reflect the fields that are available in your Salesforce instance for that record type. Any field with _c at the end is a custom field. NOTE: All date fields will be output in standard UTC format. data 

    • id (number): the unique identifier of the Salesforce record you are reading
    • ParentId (number): the unique identifier of the parent record in Salesforce to which that record is associated
    • Name_ (text):_ name of the record
    • Type_ (text):_ the category of the record you are reading, represented in your Salesforce instance as a dropdown menu. This field will return plain text
    • OwnerId (number): the unique identifier of the owner of the record
  • Search

    Searches records in Salesforce for term(s) of your choosing and outputs the unique ID of the first record that is found matching your search term(s). Because only one record ID is returned, we recommend searching by a unique term (for example, Email if you are searching for a contact) to ensure this action outputs the ID you are looking for. Are you looking for Gainsight help? Click here.

    Options

    • Record type (dropdown): a dropdown of your available record types in Salesforce, including custom records

    Input Fields

    Input fields are dynamically generated and will reflect the fields that are available in your Salesforce instance for that record type. You can search by a minimum of one or a combination of multiple inputs to find the record ID. Any field with _c at the end is a custom field. NOTE: If you are searching by a date field in this action, it must be in standard UTC format.

    Output Fields

    data 

    • id (number): the unique identifier in Salesforce of the first record that was found matching your search term(s)
  • Update

    Update

    Updates an existing record in Salesforce of the type you choose.

    Are you looking for Gainsight help? Click here.

    Options

    • Record type (dropdown): a dropdown of your available record types in Salesforce, including custom records

    Input Fields

    record 

    • id (number): the unique identifier of the existing record in Salesforce you wish to update. NOTE: This is a required field and must be the standard ID of the record in Salesforce

    fields

    Input fields are dynamically generated and will reflect the fields that are available in your Salesforce instance for that record type. For any field you update using this action, it will overwrite existing data in that field. All field with _c at the end are custom fields. NOTE: for any field you are writing to in this action that requires a date, it must be in standard UTC format. The Salesforce API will automatically convert it to the timezone of your instance.

    Here are some standard fields that you may see as inputs on your action:

    • ParentId (number): the unique identifier of the parent record in Salesforce to which you want to associate this record
    • Name_ (text):_ name of the record that you are updating
    • Type_ (picklist):_ the category of the record you are updating, represented in your Salesforce instance as a dropdown menu. NOTE: You can write any value to this field, but we recommend matching the exact spelling and capitalization to the available dropdown options to ensure consistency across your records
    • OwnerId (number): the unique identifier of the owner of the record you are updating. You can search for a particular owner’s ID by using the Salesforce Search action and selecting “User” as the record type