Covered in this article
Salesforce pages
Created on Updated on
Salesforce component

Salesforce Component

A component enables you to manage your organization’s sales, marketing and customer support assets, far beyond email addresses and phone numbers.

Latest changelog

1.3.2 (March 26, 2020)

  • Add new optional field Include linked objects in trigger: Get New and Updated Objects Polling

To see the full changelog please use the following link.

Description

Integration component to connect the Salesforce for the elastic.io platform.

Note: The component works with the Salesforce API. This means you must make sure your Salesforce edition has API Access enabled. To check which editions have API access see the Salesforce editions with API Access document. If your edition has no API Access by default this component will not work for you.

API version

The component uses Salesforce - API Version 45.0, except:

  • Deprecated Actions and Triggers - API Version 25.0

Authentication

Authentication occurs via OAuth 2.0.

In the component repository you need to specify OAuth Client credentials as environment variables:

  • OAUTH_CLIENT_ID - your OAuth client key

  • OAUTH_CLIENT_SECRET - your OAuth client secret

Note: We renamed the environment variables SALESFORCE_KEY and SALESFORCE_SECRET to standardize the OAuth workflow.

To get these values you can check the creating OAuth App for Salesforce article.

The component completeness matrix gives the technical details about Salesforce objects this component covers.

Credentials

During credentials creation you would need to:

  • Choose Environment

  • Enter Username and Password in a pop-up window after click on Authenticate button.

  • Verify and save your new credentials.

Note: When you deploy the Salesforce component separately into a dedicated tenant or into your developer team it can not use the OAuth App specifically created for our main elastic.io tenant. For this purposes you must create a different OAuth App and add the required environment variables to the component setup.

Triggers

Salesforce component includes the following triggers:

  1. Query trigger
    Continuously runs the same SOQL Query and emits results one-by-one. Use the Salesforce Object Query Language (SOQL) to search your organization’s Salesforce data for specific information.

  2. Get New and Updated Objects Polling trigger
    Polls existing and updated objects. You can select any custom or built-in object for your Salesforce instance.

  3. Subscribe to platform events
    This trigger will subscribe for any platform Event using Salesforce streaming API.

The following Salesforce triggers are deprecated:

  1. New Case trigger(deprecated)
    Polls existing and updated Cases (fetches a maximum of 1000 objects per execution)
    Trigger is deprecated. You can use Get New and Updated Objects Polling trigger instead.

  2. New Lead trigger(deprecated)
    Polls existing and updated Leads (fetches a maximum of 1000 objects per execution)
    Trigger is deprecated. You can use Get New and Updated Objects Polling trigger instead.

  3. New Contact trigger(deprecated)
    Polls existing and updated Contacts (fetches a maximum of 1000 objects per execution) Trigger is deprecated. You can use Get New and Updated Objects Polling trigger instead.

  4. New Account trigger(deprecated)
    Polls existing and updated Accounts (fetches a maximum of 1000 objects per execution) Trigger is deprecated. You can use Get New and Updated Objects Polling trigger instead.

  5. New Task trigger(deprecated)
    Polls existing and updated Tasks (fetches a maximum of 1000 objects per execution)
    Trigger is deprecated. You can use Get New and Updated Objects Polling trigger instead.

Actions

Use this list to navigate to the action you seek.

  1. Query action
    Executing a SOQL Query that may return many objects. Each resulting object is emitted one-by-one. Use the Salesforce Object Query Language (SOQL) to search your organization’s Salesforce data for specific information.

  2. Create Object action
    Creates a new Selected Object. Action creates a single object.

  3. Delete Object action
    Deletes an object by a selected field. One can filter by either unique fields or all fields of that sobject.

  4. Upsert Object action
    Creates or Updates Selected Object. Action creates a single object.

  5. Lookup Object action(at most 1)
    Lookup an object by a selected field. Action creates a single object.

  6. Lookup Objects action
    Lookup a list of objects satisfying specified criteria.

  7. Bulk Create/Update/Delete action
    Bulk API provides a simple interface for quickly loading large amounts of data from CSV file into Salesforce.

  8. Bulk Query action
    Fetches records to a CSV file.

The following Salesforce actions are deprecated:

  1. Lookup Object (deprecated)
    Lookup an object by a selected field.Action is deprecated. You can use Lookup Object action or Lookup Object action (at most 1) instead.

  2. New Account (deprecated)
    This action will automatically retrieve all existing fields of Account object type that available on your Salesforce organization. Action is deprecated. You can use Create Object action instead.

  3. New Case (deprecated)
    Creates a new Case. Action is deprecated. You can use Create Object action instead.

  4. New Contact (deprecated)
    Creates a new Contact. Action is deprecated. You can use Create Object action instead.

  5. New Event (deprecated)
    Creates a new Event. Action is deprecated. You can use Create Object action instead.

  6. New Lead (deprecated)
    Creates a new Lead. Action is deprecated. You can use Create Object action instead.

  7. New Note (deprecated)
    Creates a new Note. Action is deprecated. You can use Create Object action instead.

  8. New Task (deprecated)
    Creates a new Task. Action is deprecated. You can use Create Object action instead.

Known limitations

Attachments mechanism does not work with Local Agent Installation