Lookup

NOTE: The Salesforce section of this documentation is under construction. The articles in this section may be incomplete.

Extract information from a Salesforce object using a standard SQL query with a WHERE clause.

Inputs

Key		Value
`sObjectName`	Required	The Salesforce object type that you want to look up (e.g. “Opportunity”, “Account”, “WorkOrder”, etc.)
`where`	Required	The text of the WHERE clause of the SQL query that will be issued to Salesforce by the Lookup action. The purpose of the query is to identify a unique object of type `sObjectName`. This is typically done by specifying the unique Salesforce ID of the desired object, but you can use other constraints as well. If you are using the Lookup action in conjunction with the Salesforce Webhook trigger and want to access the Salesforce object that activated the webhook, simply use the Salesforce Webhook’s `where_value` output by typing `Id = '#{trigger.[where_value]}'`
`field_<any_string>`	Optional	The name of a field to be retrieved from the Salesforce object specified by the previous two inputs. The key can be anything starting with “field_”, while the value must be a Salesforce field name. You can access these field names in Salesforce under the Build → Customize heading, see Salesforce documentation for more details. The following additional rules apply to the values for this input: Use dot notation to reference subfields of a field that points to another Salesforce object. For instance, “Asset.ProductCode” means the “ProductCode” subfield of an “Asset” field within your object. For custom fields, use “c” at the end of the field name when referencing a field that does not point to another object, and use “r” for for fields that DO reference another object. For example, “Technician__r.Username” would refer to the “Username” subfield within your object’s custom field called “Technician”.

Key

Value

sObjectName

Required

The Salesforce object type that you want to look up (e.g. “Opportunity”, “Account”, “WorkOrder”, etc.)

where

Required

The text of the WHERE clause of the SQL query that will be issued to Salesforce by the Lookup action. The purpose of the query is to identify a unique object of type sObjectName. This is typically done by specifying the unique Salesforce ID of the desired object, but you can use other constraints as well. If you are using the Lookup action in conjunction with the Salesforce Webhook trigger and want to access the Salesforce object that activated the webhook, simply use the Salesforce Webhook’s where_value output by typing Id = '#{trigger.[where_value]}'

field_<any_string>

Optional

The name of a field to be retrieved from the Salesforce object specified by the previous two inputs. The key can be anything starting with “field_”, while the value must be a Salesforce field name. You can access these field names in Salesforce under the Build → Customize heading, see Salesforce documentation for more details.

The following additional rules apply to the values for this input:

Use dot notation to reference subfields of a field that points to another Salesforce object. For instance, “Asset.ProductCode” means the “ProductCode” subfield of an “Asset” field within your object.
For custom fields, use “**c” at the end of the field name when referencing a field that does not point to another object, and use “**r” for for fields that DO reference another object. For example, “Technician__r.Username” would refer to the “Username” subfield within your object’s custom field called “Technician”.

Outputs

Key	Value
`field_<any_string>`	The value retrieved by the corresponding "field_<any_string>" input. So if the key is field_TechnicianName, then this will be the value of the Salesforce field retrieved by the “field_TechnicianName” input.

Usage

A common purpose of looking up information from a Salesforce object is to use it to pre-populate some fields in a GoFormz form or other GoFormz object. For this reason, the Lookup action is typically used in conjunction with actions like Create Form, Update Form, Add Data Source Rows, etc. Those actions then reference the Lookup's outputs.