Before you use this tool

The user the connection acts as needs a CloudFiles Document Generation license. See Who the Agent Acts As. Templates must be published in CloudFiles to be listed. Draft templates are not available to agents, and templates built for HubSpot are not listed.

Inputs

InputRequiredDescription
objectTypeNoSalesforce object API name, such as Opportunity or Invoice__c. Case does not matter.
searchNoWords to find in a template's name, description or tags. A template matches when it contains every word. Case does not matter.

Outputs

FieldDescription
templatesEvery matching template, newest first, with the fields below.
idThe template's ID, used to generate from it.
externalKeyA stable name an admin gave the template, when it has one.
nameThe template's name.
descriptionThe template's description, when it has one.
objectTypeThe Salesforce object the template generates from.
kindThe file type: docx, pptx, xlsx or pdf.
tagsThe template's tags.
versionNumberThe template's version number.
updatedAtWhen the template last changed, in ISO 8601 format.
variablesThe values to supply when generating, with the fields in the next table.
totalHow many templates matched.

Variable fields

FieldDescription
nameThe name to use when supplying a value to generate-document.
labelThe variable's label.
typeThe data type, such as string, double or date.
defaultValueThe variable's default value, when it has one.
isCollectionVariabletrue when the variable takes a list of values.

Example requests

You askWhat the agent does
What templates can I use on this opportunity?Calls list-templates with objectType set to Opportunity and lists the templates by name.
Do we have an NDA template?Calls list-templates with search set to NDA and lists the matches.
What values does the NDA template need?Calls list-templates, finds the NDA template and lists its variables with their labels and types.