Salesforce

CRM Services.

Case Management · Salesforce

Details

IDSalesforce
ProviderSalesforce
CategoryCase Management
From Version5.0.0
Supported ModulesAgentix XSIAM EDR Cortex Cloud Cloud Runtime Security

README

 

Overview

Use the Salesforce integration to search, query, and add new objects (tasks, accounts, cases, and so on) to Salesforce directly from Cortex XSOAR.

Support Salesforce API Version 63.0.

The fetch incident option enables you to monitor the creation of new Salesforce cases and manage them in Cortex XSOAR.

Use cases

Search for data: !salesforce-search pattern=”1234”

This command will return all relevant objects containing the string 1234 as a part of their data.

Querying the data base: !salesforce-query query=“SELECT Subject,Description FROM User WHERE CreatedDate>2018-01-01T00:00:00Z”

This command will return the subject and description of all cases that were created in 2018.

Creating Cases: !salesforce-add-case status="On Hold" subject="adding case from command add-case" type="Feature Request" priority=Low

This command will create a new Salesforce case with the given data.

Submitting Chatter message: !salesforce-push-comment oid=5003600000Smg4sAAB text="adding comment to case" link="google.com"

This command will add a new comment to the object oid and result with the following comment.
image

Configure Salesforce to Work with Cortex XSOAR

  1. Add a new connected App in Salesforce. For more information, see the Salesforce documentation.
  2. If you already have a connected App, navigate to Setup > App Manager and select the correct App from the list, and click View.
  3. You can find the Consumer Key / Secret under API (Enable OAuth Settings).
    For detailed instructions see the Credentials walkthrough section.

Configure the Salesforce Integration on Cortex XSOAR

  1. Navigate to Settings > Integrations > Servers `&` Services.
  2. Search for Salesforce.
  3. Click Add instance to create and configure a new integration instance.
    • Name: a textual name for the integration instance.
    • Instance URL: A URL to the instance.
    • Credentials: The username for accessing the instance
    • Consumer Key: The Consumer Key set for this integration with Cortex XSOAR, as explained in 'Setting Salesforce'
    • Consumer Secret: The Consumer Secret set for this integration with Cortex XSOAR, as explained in 'Setting Salesforce' above.
    • Trust any certificate (not secure)
    • Fetch type: cases/comments (Only fetch comments when using the SalesforceAskUser automation)
    • Use system proxy settings
    • Fetch incidents
    • Incident type
  4. Click Test to validate the URLs, token, and connection.

Fetched Incidents Data

The fetch command monitors the creation of new cases starting from the time the option was enabled.

Commands

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

  1. Search Salesforce records: salesforce-search
  2. Perform a query using SOQL: salesforce-query
  3. Get an object: salesforce-get-object
  4. Update an object: salesforce-update-object
  5. Create an object: salesforce-create-object
  6. Add a comment to chatter: salesforce-push-comment
  7. Get case information: salesforce-get-case
  8. Create a case: salesforce-create-case
  9. Update a case: salesforce-update-case
  10. Get all cases: salesforce-get-cases
  11. Close a case: salesforce-close-case
  12. Add a comment to a chatter thread: salesforce-push-comment-threads
  13. Delete a case: salesforce-delete-case

1. Search Salesforce records

Search records that contain values with pattern.

Base Command

salesforce-search

Input
Argument Name Description Required
pattern String or number to search Required
 
Context Output
Path Type Description
SalesForce.Case.ID string Case Object ID
SalesForce.Case.CaseNumber string Case number
SalesForce.Case.Subject string Case subject
SalesForce.Case.Description string Case description
SalesForce.Case.CreateDate date Time the case was created
SalesForce.Case.ClosedDate date Time the case was closed
SalesForce.Case.Owner string Case owner
SalesForce.Case.Priority string Case priority (Low, Medium, High)
SalesForce.Case.Origin string How case originated (Web, Phone, Email)
SalesForce.Case.Status string Case status (New, Escalated, On Hold, or Closed)
SalesForce.Case.Reason string Reason the case was created
SalesForce.Contact.ID string Contact ID
SalesForce.Contact.Name string Contact name
SalesForce.Contact.Account string Account associated with the contact information
SalesForce.Contact.Title string Contact title
SalesForce.Contact.Phone string Contact phone number
SalesForce.Contact.MobliePhone string Contact mobile number
SalesForce.Contact.Email string Contact email address
SalesForce.Contact.Owner string Contact owner
SalesForce.Lead.ID string Lead ID
SalesForce.Lead.Name string Lead name
SalesForce.Lead.Title string Lead title
SalesForce.Lead.Company string Lead company
SalesForce.Lead.Phone string Lead phone number
SalesForce.Lead.Mobile string Lead mobile number
SalesForce.Lead.Email string Lead email address
SalesForce.Lead.Owner string Lead owner
SalesForce.Lead.Status string Lead status (New, Nurturing, Working, Qualified, or Unqualified)
SalesForce.Task.ID string Task ID
SalesForce.Task.Subject string Task subject
SalesForce.Task.Lead string Task leader
SalesForce.Task.RelatedTo string Relevant account
SalesForce.Task.DueDate date Task due date
SalesForce.User.ID string User's ID
SalesForce.User.Name string User's name
SalesForce.User.Title string User's title
SalesForce.User.Phone string User's phone number
SalesForce.User.Email string User's email address

 

2. Perform a query using SOQL

Query Salesforce with SOQL

Base Command

salesforce-query

Input
Argument Name Description Required
query Query in SOQL format: "SELECT name from Account" Required
 
Context Output

There is no context output for this command.

Command Example

image

3. Get an object

Get object by path

Base Command

salesforce-get-object

Input
Argument Name Description Required
path Object path, for example: "Case/5000Y000001EjzRQAS" for Object "Case" with ID "5000Y000001EjzRQAS" Required
 
Context Output
Path Type Description
SalesForce.Case.ID string Case Object ID
SalesForce.Case.CaseNumber string Case number
SalesForce.Case.Subject string Case subject
SalesForce.Case.Description string Case description
SalesForce.Case.CreateDate date Time the case was created
SalesForce.Case.ClosedDate date Time the case was closed
SalesForce.Case.Owner string Case owner
SalesForce.Case.Priority string Case priority (Low, Medium, High)
SalesForce.Case.Origin string How case originated (Web, Phone, Email)
SalesForce.Case.Status string Case status (New, Escalated, On Hold, or Closed)
SalesForce.Case.Reason string Reason the case was created
SalesForce.Contact.ID string Contact ID
SalesForce.Contact.Name string Contact name
SalesForce.Contact.Account string Account associated with the contact information
SalesForce.Contact.Title string Contact title
SalesForce.Contact.Phone string Contact phone number
SalesForce.Contact.MobliePhone string Contact mobile number
SalesForce.Contact.Email string Contact email address
SalesForce.Contact.Owner string Contact owner
SalesForce.Lead.ID string Lead ID
SalesForce.Lead.Name string Lead name
SalesForce.Lead.Title string Lead title
SalesForce.Lead.Company string Lead company
SalesForce.Lead.Phone string Lead phone number
SalesForce.Lead.Mobile string Lead mobile number
SalesForce.Lead.Email string Lead email address
SalesForce.Lead.Owner string Lead owner
SalesForce.Lead.Status string Lead status (New, Nurturing, Working, Qualified, or Unqualified)
SalesForce.Task.ID string Task ID
SalesForce.Task.Subject string Task subject
SalesForce.Task.Lead string Task leader
SalesForce.Task.RelatedTo string Relevant account
SalesForce.Task.DueDate date Task due date
SalesForce.User.ID string User ID
SalesForce.User.Name string User's name
SalesForce.User.Title string User's title
SalesForce.User.Phone string User's phone number
SalesForce.User.Email string User's email
 
Command Example
Context Example
Human Readable Output

4. Update an object

Update object fields

Base Command

salesforce-update-object

Input
Argument Name Description Required
path Object path, for example: "Case/5000Y000001EjzRQAS" for Object "Case" with ID "5000Y000001EjzRQAS" Required
json JSON with fields and values of the object to be updated Required
 
Context Output
Path Type Description
SalesForce.Case.ID string Case Object ID
SalesForce.Case.CaseNumber string Case number
SalesForce.Case.Subject string Case subject
SalesForce.Case.Description string Case description
SalesForce.Case.CreateDate date Time case was created
SalesForce.Case.ClosedDate date Time case was closed
SalesForce.Case.Owner string Case owner
SalesForce.Case.Priority string Case priority (Low, Medium, High)
SalesForce.Case.Origin string How case originated (Web, Phone, Email)
SalesForce.Case.Status string Case status (New, Escalated, On Hold, or Closed)
SalesForce.Case.Reason string Reason the case was created
SalesForce.Contact.ID string Contact ID
SalesForce.Contact.Name string Contact name
SalesForce.Contact.Account string Account associated with the contact information
SalesForce.Contact.Title string Contact title
SalesForce.Contact.Phone string Contact phone number
SalesForce.Contact.MobliePhone string Contact mobile number
SalesForce.Contact.Email string Contact email address
SalesForce.Contact.Owner string Contact owner
SalesForce.Lead.ID string Lead ID
SalesForce.Lead.Name string Lead name
SalesForce.Lead.Title string Lead title
SalesForce.Lead.Company string Lead company
SalesForce.Lead.Phone string Lead phone number
SalesForce.Lead.Mobile string Lead mobile number
SalesForce.Lead.Email string Lead email address
SalesForce.Lead.Owner string Lead owner
SalesForce.Lead.Status string Lead status (New, Nurturing, Working, Qualified, or Unqualified)
SalesForce.Task.ID string Task ID
SalesForce.Task.Subject string Task subject
SalesForce.Task.Lead string Task leader
SalesForce.Task.RelatedTo string Relevant account
SalesForce.Task.DueDate date Task due date
SalesForce.User.ID string User's ID
SalesForce.User.Name string User's name
SalesForce.User.Title string User's title
SalesForce.User.Phone string User's phone number
SalesForce.User.Email string User's email

 

5. Create an object

Create new object

Base Command

salesforce-create-object

Input
Argument Name Description Required
path Object path, for example: "Case" for Object "Case" Required
json JSON with fields and values of the object to be created Required
 
Context Output
Path Type Description
SalesForce.Case.ID string Case Object ID
SalesForce.Case.CaseNumber string Case number
SalesForce.Case.Subject string Case subject
SalesForce.Case.Description string Case description
SalesForce.Case.CreateDate date Time case was created
SalesForce.Case.ClosedDate date Time case was closed
SalesForce.Case.Owner string Case owner
SalesForce.Case.Priority string Case priority (Low, Medium, High)
SalesForce.Case.Origin string How case originated (Web, Phone, Email)
SalesForce.Case.Status string Case status (New, Escalated, On Hold, or Closed)
SalesForce.Case.Reason string Reason the case was created
SalesForce.Contact.ID string Contact ID
SalesForce.Contact.Name string Contact name
SalesForce.Contact.Account string Account associated with the contact information
SalesForce.Contact.Title string Contact title
SalesForce.Contact.Phone string Contact phone number
SalesForce.Contact.MobliePhone string Contact mobile number
SalesForce.Contact.Email string Contact email
SalesForce.Contact.Owner string Contact owner
SalesForce.Lead.ID string Lead ID
SalesForce.Lead.Name string Lead name
SalesForce.Lead.Title string Lead title
SalesForce.Lead.Company string Lead company
SalesForce.Lead.Phone string Lead phone number
SalesForce.Lead.Mobile string Lead mobile number
SalesForce.Lead.Email string Lead email
SalesForce.Lead.Owner string Lead owner
SalesForce.Lead.Status string Lead status (New, Nurturing, Working, Qualified, or Unqualified)
SalesForce.Task.ID string Task ID
SalesForce.Task.Subject string Task subject
SalesForce.Task.Lead string Task leader
SalesForce.Task.RelatedTo string Relevant account
SalesForce.Task.DueDate date Task due date
SalesForce.User.ID string User's ID
SalesForce.User.Name string User's name
SalesForce.User.Title string User's title
SalesForce.User.Phone string User's hone number
SalesForce.User.Email string User's email address

 

6. Add a comment to chatter

Add a comment to chatter

Base Command

salesforce-push-comment

Input
Argument Name Description Required
oid Object ID of subject Required
text Chat text Required
link Add a link to the message Optional
 
Context Output
Path Type Description
SalesForce.Comment.Body string Comment body
SalesForce.Comment.CreatedDate date Comment created date
SalesForce.Comment.Title string Comment title
SalesForce.Comment.ParentType string Comment parent type
SalesForce.Comment.ParentName string Comment parent name
SalesForce.Comment.URL string Comment URL link
SalesForce.Comment.Visibility string Comment visibility
 
Command Example

image

Context Example

image

7. Get case information

Get information for a specified on a case. All arguments are optional, but you must specify at least one for the command to execute successfully.

Base Command

salesforce-get-case

Input
Argument Name Description Required
oid Object ID of the case Optional
caseNumber Case number Optional
 
Context Output
Path Type Description
SalesForce.Case.ID string Case Object ID
SalesForce.Case.CaseNumber string Case number
SalesForce.Case.Subject string Case subject
SalesForce.Case.Description string Case description
SalesForce.Case.CreateDate date Time case was created
SalesForce.Case.ClosedDate date Time case was closed
SalesForce.Case.Owner string Case owner
SalesForce.Case.Priority string Priority of the case (Low, Medium, High)
SalesForce.Case.Origin string How case originated (Web, Phone, Email)
SalesForce.Case.Status string Case status (New, Escalated, On Hold, or Closed)
SalesForce.Case.Reason string Reason the case was created
 
Command Example

image

Context Example

image

8. Create a case

Create a new case

Base Command

salesforce-create-case

Input
Argument Name Description Required
subject Case subject Required
description Case description Optional
status Case status Required
origin Case origin Optional
priority Case priority Optional
type Case type Optional
 
Context Output
Path Type Description
SalesForce.Case.ID string Case Object ID
SalesForce.Case.CaseNumber string Case number
SalesForce.Case.Subject string Case subject
SalesForce.Case.Description string Case description
SalesForce.Case.CreateDate date Time case was created
SalesForce.Case.ClosedDate date Time case was closed
SalesForce.Case.Owner string Case owner
SalesForce.Case.Priority string Priority of the case (Low, Medium, High)
SalesForce.Case.Origin string How case originated (Web, Phone, Email)
SalesForce.Case.Status string Case status (New, Escalated, On Hold, or Closed)
SalesForce.Case.Reason string Reason for case creation

 

9. Update a case

Update case fields

Base Command

salesforce-update-case

Input
Argument Name Description Required
oid Case Object ID Optional
caseNumber Case number Optional
subject Case subject Optional
description Case description Optional
status Case status Optional
origin Case origin Optional
priority Case priority Optional
type Case type Optional
 
Context Output
Path Type Description
SalesForce.Case.ID string Case Object ID
SalesForce.Case.CaseNumber string Case number
SalesForce.Case.Subject string Case subject
SalesForce.Case.Description string Case description
SalesForce.Case.CreateDate date Time case was created
SalesForce.Case.ClosedDate date Time case was closed
SalesForce.Case.Owner string Case owner
SalesForce.Case.Priority string Priority of the case (Low, Medium, High)
SalesForce.Case.Origin string How case originated (Web, Phone, Email)
SalesForce.Case.Status string Case status (New, Escalated, On Hold, or Closed)
SalesForce.Case.Reason string Reason the case was created

 

10. Get all cases

Get all cases

Base Command

salesforce-get-cases

Input

There is no input for this command.

Context Output

There is no context output for this command.

11. Close a case

Close a case

Base Command

salesforce-close-case

Input
Argument Name Description Required
oid Case Object ID Optional
caseNumber Case Number Optional
 
Context Output
Path Type Description
SalesForce.Case.ID string Case Object ID
SalesForce.Case.CaseNumber string Case Number
SalesForce.Case.Subject string Case Subject
SalesForce.Case.Description string Case Description
SalesForce.Case.CreateDate date Creation Time of Case
SalesForce.Case.ClosedDate date Closure Time of Case
SalesForce.Case.Owner string Case Owner
SalesForce.Case.Priority string Priority of the Case. one of Low, Medium, High.
SalesForce.Case.Origin string Origin of the Case. one of Web, Phone, Email.
SalesForce.Case.Status string Case Status. one of the following: New, Escalated, On Hold or Closed.
SalesForce.Case.Reason string Reason for case creation
 
Command Example

image

12. Add a comment to a chatter thread

Add the comment to the chatter thread. Use this command only after salesforce-push-comment

Base Command

salesforce-push-comment-threads

Input
Argument Name Description Required
id The Chatter comment Thread ID Required
text The comment text Required
 
Context Output
Path Type Description
SalesForce.Comment.Reply.Body string Reply body
SalesForce.Comment.Reply.CreatedDate date Reply created date
SalesForce.Comment.Reply.URL string Reply URL link

 

13. Delete a case

Delete a specified on a case. All arguments are optional, but you must specify at least one for the command to execute successfully.

Base Command

salesforce-get-case

Input
Argument Name Description Required
oid Object ID of the case Optional
caseNumber Case number Optional
 

 

Troubleshooting

Connection error:

  • This error indicates that there is a problem with the credentials or the IP connection to the app (see step 6-7 in Credentials walkthrough below).

     

  • This error indicates a problem in the Costumer Key:

     

  • This error indicates a problem in the Costumer Secret:

     
     

Credentials walkthrough:

 1. Open Setup.

 

2. Go to the App manager on the left side menu (use Quick Find for faster search).
 

3. Click “New Connected App” on the right side of the screen.

4. Fill in the form as follows:

  • Mark “Enable OAuth Settings”.
  • In “Selected OAuth Scopes”, Add the following:
    • Access and manage your Chatter data (chatter_api)
    • Access and manage your data (api)

5. Click “Save” at the bottom of the form.

6. In the information page on the APP that you will be forwarded to locate “API (Enable OAuth Settings)” and copy the consumer key and secret to the integration instance configuration.

6. Go to “Manage Connected Apps”.

7. Edit the new application and under “OAuth Policies” enable all IP address.

  

salesforce-get-casecomment

Returns a comment through the case number.

Base Command

salesforce-get-casecomment

Input

Argument Name Description Required
oid Returns information of a case. Optional
caseNumber The case number of the case. Optional

Context Output

Path Type Description
ID string The ID of the case.
ParentId string The ID of the parent case of the case comment. Required.
IsPublished boolean Whether the case comment is visible to customers in the Self-Service portal (true). The label is published. This is the only CaseComment field that can be updated through the API.
CommentBody string The text of the case body. Maximum size is 4,000 bytes. The label is Body.
CreatedById unknown The created date by ID.
CreatedDate string The created date.
SystemModstamp string The SystemMod stamp.
LastModifiedDate string The last modified date.
LastModifiedById string The last modified date by ID.
IsDeleted boolean Whether the object has been moved to the Recycle Bin (true). Label is Deleted.

salesforce-post-casecomment

The post comment through the case number.

Base Command

salesforce-post-casecomment

Input

Argument Name Description Required
oid The Object ID of the case. Optional
caseNumber The case number of the case. Optional
text Added Text to context. Optional

Context Output

There is no context output for this command.

salesforce-get-user

Returns the UserName through the case number.

Base Command

salesforce-get-user

Input

Argument Name Description Required
oid The Object ID of the case. Optional
caseNumber The case number of the case. Optional

Context Output

Path Type Description
ID string The ID of the case.
Alias string The user’s alias. Required. For example, jsmith.
CommunityNickname string The name used to identify the user in the Community application, which includes the ideas and answers features.
CreatedById string Created by the ID.
Email string The user’s email address. Required.
LastLoginDate string The time and date when the user last successfully logged in. This value is updated if 60 seconds have elapsed since the user’s last login.
LastModifiedDate string The last modified date.
LastName string The user’s last name. Required.
Name string Concatenation of FirstName and LastName. Limited to 121 characters.
Username string Contains the name that a user enters to log in to the API or the user interface. Required. Must be in the form of an email address, all characters should be lowercase, and unique across all organizations. Each added user counts as a license. Every organization has a maximum number of licenses. If you attempt to exceed the maximum number of licenses by inserting user records, the attempt to create a user is rejected.
UserRoleId string The ID of the user’s UserRole. Label is Role ID.

salesforce-get-org

Returns organization details from the case number.

Base Command

salesforce-get-org

Input

Argument Name Description Required
caseNumber The case number of the case. Optional

Context Output

Path Type Description
ID string The unique ID of the case.
Name string Name of the account. Required. Label is Account Name. Maximum size is 255 characters. If the account has a record type of Person Account, this value is the concatenation of the FirstName, MiddleName, LastName, and Suffix of the associated person contact. You cannot modify this value.

salesforce-file-delete

Soft-deletes a file (ContentDocument), moving it to the Recycle Bin and cascading to its versions. Recoverable for 15 days.

Base Command

salesforce-file-delete

Input

Argument Name Description Required
type The Salesforce sObject type. Default is ContentDocument. Optional
id The ContentDocument record ID to delete. Required
ignore_not_found Whether to treat a 404/NOT_FOUND response as success. Possible values are: true, false. Default is true. Optional

Context Output

Path Type Description
SalesForce.Remediation.Action string The remediation action performed.
SalesForce.Remediation.ObjectType string The Salesforce sObject type acted on.
SalesForce.Remediation.Id string The record ID acted on.
SalesForce.Remediation.Status string The result status of the remediation action.

Command example

!salesforce-file-delete id=069dn000007JlATAA0

Context Example

{
    "SalesForce": {
        "Remediation": {
            "Action": "Delete File",
            "Id": "069dn000007JlATAA0",
            "ObjectType": "ContentDocument",
            "Status": "Deleted"
        }
    }
}

Human Readable Output

Salesforce Remediation - Delete File

Action Id ObjectType Status
Delete File 069dn000007JlATAA0 ContentDocument Deleted

salesforce-knowledge-article-archive

Archives a Knowledge article (non-destructive). Sets PublishStatus to Archived via the standard archiveKnowledgeArticles action. Reversible to Draft/Online.

Base Command

salesforce-knowledge-article-archive

Input

Argument Name Description Required
type The Salesforce sObject type. Default is KnowledgeArticleVersion. Optional
id The Knowledge article version ID (the __kav record ID, starting with ‘ka’) to archive. Required
ignore_not_found Whether to treat a 404/NOT_FOUND response as success. Possible values are: true, false. Default is true. Optional

Context Output

Path Type Description
SalesForce.Remediation.Action string The remediation action performed.
SalesForce.Remediation.ObjectType string The Salesforce sObject type acted on.
SalesForce.Remediation.Id string The record ID acted on.
SalesForce.Remediation.Status string The result status of the remediation action.

Command example

!salesforce-knowledge-article-archive id=ka1dn0000001ZwbAAE

Context Example

{
    "SalesForce": {
        "Remediation": {
            "Action": "Archive Knowledge Article",
            "Id": "ka1dn0000001ZwbAAE",
            "ObjectType": "KnowledgeArticleVersion",
            "Status": "Archived"
        }
    }
}

Human Readable Output

Salesforce Remediation - Archive Knowledge Article

Action Id ObjectType Status
Archive Knowledge Article ka1dn0000001ZwbAAE KnowledgeArticleVersion Archived

salesforce-file-public-link-list

Lists all public links (ContentDistribution records) for a given ContentDocument ID. Use the returned ContentDistribution IDs with salesforce-file-public-link-remove to remove each link.

Base Command

salesforce-file-public-link-list

Input

Argument Name Description Required
id The ContentDocument record ID whose public links (ContentDistribution rows) should be listed. Required

Context Output

Path Type Description
SalesForce.ContentDistribution.Id string The ContentDistribution record ID (use with salesforce-file-public-link-remove).
SalesForce.ContentDistribution.ContentDocumentId string The parent ContentDocument ID.
SalesForce.ContentDistribution.Name string The name of the content distribution.
SalesForce.ContentDistribution.PublicUrl string The public distribution URL.

Command example

!salesforce-file-public-link-list id=069dn000007PpOIAA0

Context Example

{
    "SalesForce": {
        "ContentDistribution": {
            "ContentDocumentId": "069dn000007PpOIAA0",
            "Id": "05Ddn000000VfWjEAK",
            "Name": "cortex-test-file-01 7/28/2026",
            "PublicUrl": "https://paloaltonetworks-sahil.sandbox.my.salesforce.com/sfc/p/7X000001T5lm/a/dn000000VfWj/TExjFQ7nttSYbbnXER8CaxGLqYDmVhzw2LEe1jg9_Vo"
        }
    }
}

Human Readable Output

Salesforce File Public Links (ContentDistribution) for 069dn000007PpOIAA0

ContentDocumentId Id Name PublicUrl
069dn000007PpOIAA0 05Ddn000000VfWjEAK cortex-test-file-01 7/28/2026 https://paloaltonetworks-sahil.sandbox.my.salesforce.com/sfc/p/7X000001T5lm/a/dn000000VfWj/TExjFQ7nttSYbbnXER8CaxGLqYDmVhzw2LEe1jg9_Vo

salesforce-file-public-link-remove

Removes a file public link by deleting a single ContentDistribution record. The external link is severed immediately and irreversibly.

Base Command

salesforce-file-public-link-remove

Input

Argument Name Description Required
type The Salesforce sObject type. Default is ContentDistribution. Optional
id The ContentDistribution record ID to delete (severs the public link). Use salesforce-file-public-link-list to obtain distribution IDs for a ContentDocument. Required
ignore_not_found Whether to treat a 404/NOT_FOUND response as success. Possible values are: true, false. Default is true. Optional

Context Output

Path Type Description
SalesForce.Remediation.Action string The remediation action performed.
SalesForce.Remediation.ObjectType string The Salesforce sObject type acted on.
SalesForce.Remediation.Id string The ContentDistribution record ID acted on.
SalesForce.Remediation.Status string The result status of the remediation action.

Command example

!salesforce-file-public-link-remove id=05Ddn000000VfWjEAK

Context Example

{
    "SalesForce": {
        "Remediation": {
            "Action": "Remove File Public Link",
            "Id": "05Ddn000000VfWjEAK",
            "ObjectType": "ContentDistribution",
            "Status": "Deleted"
        }
    }
}

Human Readable Output

Salesforce Remediation - Remove File Public Link

Action Id ObjectType Status
Remove File Public Link 05Ddn000000VfWjEAK ContentDistribution Deleted

salesforce-knowledge-article-draft-create

Moves a published Knowledge article to Draft using the standard createDraftFromOnlineKnowledgeArticle action. By default (unpublish=true) the online version is removed from public visibility and an editable draft is created.

Base Command

salesforce-knowledge-article-draft-create

Input

Argument Name Description Required
type The Salesforce sObject type. Default is KnowledgeArticleVersion. Optional
id The Knowledge article ID (KnowledgeArticleId, starting with ‘kA’) or article version ID (starting with ‘ka’). Used with the standard createDraftFromOnlineKnowledgeArticle action. Required
unpublish Whether to archive the current online version (removing it from public visibility) and create a new draft. If false, keeps the article online and creates an editable draft alongside it. Possible values are: true, false. Default is true. Optional
ignore_not_found Whether to treat a 404/NOT_FOUND response as success. Possible values are: true, false. Default is true. Optional

Context Output

Path Type Description
SalesForce.Remediation.Action string The remediation action performed.
SalesForce.Remediation.ObjectType string The Salesforce sObject type acted on.
SalesForce.Remediation.Id string The record ID acted on.
SalesForce.Remediation.Status string The result status of the remediation action.
SalesForce.Remediation.Unpublished boolean Whether the online version was unpublished (removed from public visibility).
SalesForce.Remediation.DraftVersionId string The ID of the newly created draft article version.

Command example

!salesforce-knowledge-article-draft-create id=ka1dn0000001ZyDAAU unpublish=true

Context Example

{
    "SalesForce": {
        "Remediation": {
            "Action": "Draft Knowledge Article",
            "DraftVersionId": "ka1dn0000001ZzpAAE",
            "Id": "ka1dn0000001ZyDAAU",
            "ObjectType": "KnowledgeArticleVersion",
            "Status": "Unpublished (Draft created)",
            "Unpublished": true
        }
    }
}

Human Readable Output

Salesforce Remediation - Draft Knowledge Article

Action DraftVersionId Id ObjectType Status Unpublished
Draft Knowledge Article ka1dn0000001ZzpAAE ka1dn0000001ZyDAAU KnowledgeArticleVersion Unpublished (Draft created) true

<~PLATFORM>

License Requirements

The following configuration parameters require one of these licenses: Cortex XSIAM or Agentix:

  • Fetch incidents

</~PLATFORM>

Configuration parameters

  • InstanceURL — Instance URL (required)
  • credentials — Credentials
  • clientID — Consumer Key
  • clientSecret — Consumer Secret
  • credentials_client_secret — Consumer Key
  • insecure — Trust any certificate (not secure)
  • fetchType — Fetch type: cases/comments (Only fetch comments when using the SalesforceAskUser automation)
  • useproxy — Use system proxy settings
  • isFetch — Fetch incidents
  • incidentFetchInterval — Incidents Fetch Interval
  • incidentType — Incident type

Commands (22)

  • salesforce-close-case

    Close a case

  • salesforce-create-case

    Creates a new case.

  • salesforce-create-object

    Creates a new object.

  • salesforce-delete-case

    Deletes a case.

  • salesforce-file-delete

    Soft-deletes a file (ContentDocument), moving it to the Recycle Bin and cascading to its versions. Recoverable for 15 days.

  • salesforce-file-public-link-list

    Lists all public links (ContentDistribution records) for a given ContentDocument ID. Use the returned ContentDistribution IDs with salesforce-file-public-link-remove to remove each link.

  • salesforce-file-public-link-remove

    Removes a file public link by deleting a single ContentDistribution record. The external link is severed immediately and irreversibly.

  • salesforce-get-case

    Returns information on a case. All arguments are optional, but you must specify at least one for the command to execute successfully.

  • salesforce-get-casecomment

    Returns a comment through the case number.

  • salesforce-get-cases

    Returns all cases.

  • salesforce-get-object

    Returns an object by its path.

  • salesforce-get-org

    Returns organization details from the case number.

  • salesforce-get-user

    Returns the UserName through the case number.

  • salesforce-knowledge-article-archive

    Archives a Knowledge article (non-destructive). Sets PublishStatus to Archived via the standard archiveKnowledgeArticles action. Reversible to Draft/Online.

  • salesforce-knowledge-article-draft-create

    Moves a published Knowledge article to Draft using the standard createDraftFromOnlineKnowledgeArticle action. By default (unpublish=true) the online version is removed from public visibility and an editable draft is created.

  • salesforce-post-casecomment

    The post comment through the case number.

  • salesforce-push-comment

    Adds a comment to Chatter.

  • salesforce-push-comment-threads

    Add the comment to the chatter thread. Use this command only after salesforce-push-comment

  • salesforce-query

    Queries Salesforce in SOQL format.

  • salesforce-search

    Search records that contain values with pattern

  • salesforce-update-case

    Updates case fields.

  • salesforce-update-object

    Updates object fields.

Source

Salesforce.js Salesforce.yml Salesforce_description.md command_examples.txt
Download History Raw 
sectionorder:
- Connect
- Collect
commonfields:
  id: Salesforce
  version: -1
name: Salesforce
display: Salesforce
category: Case Management
provider: Salesforce
description: CRM Services.
configuration:
- display: Instance URL
  name: InstanceURL
  defaultvalue: https://login.salesforce.com
  type: 0
  required: true
  section: Connect
- display: Credentials
  name: credentials
  defaultvalue: ""
  type: 9
  required: false
  section: Connect
- display: Consumer Key
  name: clientID
  defaultvalue: ""
  type: 0
  hidden: true
  required: false
  section: Connect
- display: Consumer Secret
  name: clientSecret
  defaultvalue: ""
  type: 4
  hidden: true
  required: false
  section: Connect
- display: Consumer Key
  displaypassword: Consumer Secret
  name: credentials_client_secret
  type: 9
  required: false
  section: Connect
- display: Trust any certificate (not secure)
  name: insecure
  type: 8
  required: false
  section: Connect
- display: 'Fetch type: cases/comments (Only fetch comments when using the SalesforceAskUser automation)'
  name: fetchType
  defaultvalue: cases
  type: 0
  required: false
  section: Connect
- display: Use system proxy settings
  name: useproxy
  type: 8
  required: false
  section: Connect
- display: Fetch incidents
  name: isFetch
  type: 8
  required: false
  section: Collect
  supportedModules:
  - agentix
  - xsiam
- display: Incidents Fetch Interval
  name: incidentFetchInterval
  type: 19
  required: false
  section: Collect
  supportedModules:
  - agentix
  - xsiam
- display: Incident type
  name: incidentType
  type: 13
  required: false
  section: Collect
  supportedModules:
  - agentix
  - xsiam
script:
  script: ''
  type: javascript
  commands:
  - name: salesforce-search
    arguments:
    - name: pattern
      required: true
      description: The string or number to search.
    outputs:
    - contextPath: SalesForce.Case.ID
      description: The ID of the case object.
      type: string
    - contextPath: SalesForce.Case.CaseNumber
      description: The case number.
      type: string
    - contextPath: SalesForce.Case.Subject
      description: The subject of the case.
      type: string
    - contextPath: SalesForce.Case.Description
      description: The description of the case.
      type: string
    - contextPath: SalesForce.Case.CreateDate
      description: The creation date the case.
      type: date
    - contextPath: SalesForce.Case.ClosedDate
      description: The closure date of the case.
      type: date
    - contextPath: SalesForce.Case.Owner
      description: The owner of the case.
      type: string
    - contextPath: SalesForce.Case.Priority
      description: 'The priority of the Case. Can be: "Low", "Medium", or "High".'
      type: string
    - contextPath: SalesForce.Case.Origin
      description: 'The origin of the case. Can be: "Web", "Phone", or "Email".'
      type: string
    - contextPath: SalesForce.Case.Status
      description: 'The status of the case. Cam be: "New", "Escalated", "On Hold", or "Closed".'
      type: string
    - contextPath: SalesForce.Case.Reason
      description: The reason for the case creation.
      type: string
    - contextPath: SalesForce.Contact.ID
      description: ID of the contact.
      type: string
    - contextPath: SalesForce.Contact.Name
      description: The name of the contact.
      type: string
    - contextPath: SalesForce.Contact.Account
      description: The account associated with the Contact information.
      type: string
    - contextPath: SalesForce.Contact.Title
      description: The title of the contact.
      type: string
    - contextPath: SalesForce.Contact.Phone
      description: The phone number of the contact.
      type: string
    - contextPath: SalesForce.Contact.MobliePhone
      description: The mobile number of the contact.
      type: string
    - contextPath: SalesForce.Contact.Email
      description: The email of the contact.
      type: string
    - contextPath: SalesForce.Contact.Owner
      description: The owner of the contact.
      type: string
    - contextPath: SalesForce.Lead.ID
      description: The Lead ID.
      type: string
    - contextPath: SalesForce.Lead.Name
      description: The Lead name.
      type: string
    - contextPath: SalesForce.Lead.Title
      description: The title of the lead.
      type: string
    - contextPath: SalesForce.Lead.Company
      description: The Lead company.
      type: string
    - contextPath: SalesForce.Lead.Phone
      description: The Lead phone number.
      type: string
    - contextPath: SalesForce.Lead.Mobile
      description: The Lead Mobile Number.
      type: string
    - contextPath: SalesForce.Lead.Email
      description: The Lead email.
      type: string
    - contextPath: SalesForce.Lead.Owner
      description: The Lead owner.
      type: string
    - contextPath: SalesForce.Lead.Status
      description: 'The lead status. Can be: "New", "Nurturing", "Working", "Qualified", or "Unqualified".'
      type: string
    - contextPath: SalesForce.Task.ID
      description: The ID of the task.
      type: string
    - contextPath: SalesForce.Task.Subject
      description: The subject of the task.
      type: string
    - contextPath: SalesForce.Task.Lead
      description: The leader of the task.
      type: string
    - contextPath: SalesForce.Task.RelatedTo
      description: The relevant account.
      type: string
    - contextPath: SalesForce.Task.DueDate
      description: The due date of the task.
      type: date
    - contextPath: SalesForce.User.ID
      description: The ID of the user.
      type: string
    - contextPath: SalesForce.User.Name
      description: The name of the user.
      type: string
    - contextPath: SalesForce.User.Title
      description: The title of the user.
      type: string
    - contextPath: SalesForce.User.Phone
      description: The phone number of the user.
      type: string
    - contextPath: SalesForce.User.Email
      description: The email of the user.
      type: string
    - contextPath: SalesForce.Case.IsEscalated
      description: Is Escalated for Case.
      type: boolean
    - contextPath: SalesForce.Case.SuppliedPhone
      description: Case Supplied Phone.
      type: string
    - contextPath: SalesForce.Case.SuppliedCompany
      description: Case Supplied Company.
      type: string
    - contextPath: SalesForce.Case.ContactEmail
      description: Case contact Email.
      type: string
    - contextPath: SalesForce.Case.ContactId
      description: Case contact Id.
      type: string
    - contextPath: SalesForce.Case.AccountId
      description: Case account ID.
      type: string
    description: Search records that contain values with pattern
  - name: salesforce-query
    arguments:
    - name: query
      required: true
      description: 'Query in SOQL format: "SELECT name from Account".'
    description: Queries Salesforce in SOQL format.
    execution: true
  - name: salesforce-get-object
    arguments:
    - name: path
      required: true
      description: 'The object path. For example, "Case/5000Y000001EjzRQAS" for Object "Case" with ID "5000Y000001EjzRQAS".'
    outputs:
    - contextPath: SalesForce.Case.ID
      description: The Object ID of the case.
      type: string
    - contextPath: SalesForce.Case.CaseNumber
      description: The case number.
      type: string
    - contextPath: SalesForce.Case.Subject
      description: The subject of the case.
      type: string
    - contextPath: SalesForce.Case.Description
      description: The description of the case.
      type: string
    - contextPath: SalesForce.Case.CreateDate
      description: The creation date of the case.
      type: date
    - contextPath: SalesForce.Case.ClosedDate
      description: The closure date of the case.
      type: date
    - contextPath: SalesForce.Case.Owner
      description: The owner of the case.
      type: string
    - contextPath: SalesForce.Case.Priority
      description: 'The priority of the case. Can be: "Low", "Medium", or "High".'
      type: string
    - contextPath: SalesForce.Case.Origin
      description: 'Origin of the case. Can be: "Web", "Phone", or "Email".'
      type: string
    - contextPath: SalesForce.Case.Status
      description: 'The status of the case. Can be: "New", "Escalated", "On Hold", or "Closed".'
      type: string
    - contextPath: SalesForce.Case.Reason
      description: The reason for the case creation.
      type: string
    - contextPath: SalesForce.Contact.ID
      description: The ID of the contact.
      type: string
    - contextPath: SalesForce.Contact.Name
      description: The name of the contact.
      type: string
    - contextPath: SalesForce.Contact.Account
      description: The account associated with the Contact information.
      type: string
    - contextPath: SalesForce.Contact.Title
      description: The title of the contact.
      type: string
    - contextPath: SalesForce.Contact.Phone
      description: The phone number of the contact.
      type: string
    - contextPath: SalesForce.Contact.MobliePhone
      description: The mobile number of the contact.
      type: string
    - contextPath: SalesForce.Contact.Email
      description: The email of the contact.
      type: string
    - contextPath: SalesForce.Contact.Owner
      description: The owner of the contact.
      type: string
    - contextPath: SalesForce.Lead.ID
      description: The Lead ID.
      type: string
    - contextPath: SalesForce.Lead.Name
      description: The Lead name.
      type: string
    - contextPath: SalesForce.Lead.Title
      description: The Lead title.
      type: string
    - contextPath: SalesForce.Lead.Company
      description: The Lead company.
      type: string
    - contextPath: SalesForce.Lead.Phone
      description: The Lead phone number.
      type: string
    - contextPath: SalesForce.Lead.Mobile
      description: The Lead mobile number.
      type: string
    - contextPath: SalesForce.Lead.Email
      description: The Lead email.
      type: string
    - contextPath: SalesForce.Lead.Owner
      description: The Lead owner.
      type: string
    - contextPath: SalesForce.Lead.Status
      description: 'The Lead status. Can be: "New", "Nurturing", "Working", "Qualified", or "Unqualified".'
      type: string
    - contextPath: SalesForce.Task.ID
      description: The ID of the task.
      type: string
    - contextPath: SalesForce.Task.Subject
      description: The subject of the task.
      type: string
    - contextPath: SalesForce.Task.Lead
      description: The leader of the task.
      type: string
    - contextPath: SalesForce.Task.RelatedTo
      description: The relevant account of the task.
      type: string
    - contextPath: SalesForce.Task.DueDate
      description: The due date of the task.
      type: date
    - contextPath: SalesForce.User.ID
      description: The ID of the user.
      type: string
    - contextPath: SalesForce.User.Name
      description: The name of the user.
      type: string
    - contextPath: SalesForce.User.Title
      description: The title of the user.
      type: string
    - contextPath: SalesForce.User.Phone
      description: The phone number of the user.
      type: string
    - contextPath: SalesForce.User.Email
      description: The email of the user.
      type: string
    description: Returns an object by its path.
  - name: salesforce-update-object
    arguments:
    - name: path
      required: true
      description: 'The object path. For example, "Case/5000Y000001EjzRQAS" for Object "Case" with ID "5000Y000001EjzRQAS".'
    - name: json
      required: true
      description: The JSON file with fields and values of the object to be updated.
    outputs:
    - contextPath: SalesForce.Case.ID
      description: The object ID of the case.
      type: string
    - contextPath: SalesForce.Case.CaseNumber
      description: The case number.
      type: string
    - contextPath: SalesForce.Case.Subject
      description: The subject of the case.
      type: string
    - contextPath: SalesForce.Case.Description
      description: The description of the case.
      type: string
    - contextPath: SalesForce.Case.CreateDate
      description: The creation date of the case.
      type: date
    - contextPath: SalesForce.Case.ClosedDate
      description: The closure time of the case.
      type: date
    - contextPath: SalesForce.Case.Owner
      description: The owner of the case.
      type: string
    - contextPath: SalesForce.Case.Priority
      description: 'The priority of the case. Can be: "Low", "Medium", or "High".'
      type: string
    - contextPath: SalesForce.Case.Origin
      description: 'The origin of the Case. Can be: "Web", "Phone", or "Email".'
      type: string
    - contextPath: SalesForce.Case.Status
      description: 'The status of the case. Can be: "New", "Escalated", "On Hold" ,or "Closed".'
      type: string
    - contextPath: SalesForce.Case.Reason
      description: The reason for the case creation.
      type: string
    - contextPath: SalesForce.Contact.ID
      description: The ID of the contact.
      type: string
    - contextPath: SalesForce.Contact.Name
      description: The name of the contact.
      type: string
    - contextPath: SalesForce.Contact.Account
      description: The account associated with the Contact information.
      type: string
    - contextPath: SalesForce.Contact.Title
      description: The title of the contact.
      type: string
    - contextPath: SalesForce.Contact.Phone
      description: The phone number of the contact.
      type: string
    - contextPath: SalesForce.Contact.MobliePhone
      description: The mobile number of the contact.
      type: string
    - contextPath: SalesForce.Contact.Email
      description: The email of the contact.
      type: string
    - contextPath: SalesForce.Contact.Owner
      description: The owner of the contact.
      type: string
    - contextPath: SalesForce.Lead.ID
      description: The Lead ID.
      type: string
    - contextPath: SalesForce.Lead.Name
      description: The Lead name.
      type: string
    - contextPath: SalesForce.Lead.Title
      description: The Lead title.
      type: string
    - contextPath: SalesForce.Lead.Company
      description: The Lead company.
      type: string
    - contextPath: SalesForce.Lead.Phone
      description: The Lead phone number.
      type: string
    - contextPath: SalesForce.Lead.Mobile
      description: The Lead mobile number.
      type: string
    - contextPath: SalesForce.Lead.Email
      description: The Lead email.
      type: string
    - contextPath: SalesForce.Lead.Owner
      description: The Lead owner.
      type: string
    - contextPath: SalesForce.Lead.Status
      description: 'The Lead Status. Can be: "New", "Nurturing", "Working", "Qualified", or "Unqualified".'
      type: string
    - contextPath: SalesForce.Task.ID
      description: The ID of the task.
      type: string
    - contextPath: SalesForce.Task.Subject
      description: The subject of the task.
      type: string
    - contextPath: SalesForce.Task.Lead
      description: The leader of the task.
      type: string
    - contextPath: SalesForce.Task.RelatedTo
      description: The relevant account.
      type: string
    - contextPath: SalesForce.Task.DueDate
      description: The due date of the task.
      type: date
    - contextPath: SalesForce.User.ID
      description: The ID of the user.
      type: string
    - contextPath: SalesForce.User.Name
      description: The name of the user.
      type: string
    - contextPath: SalesForce.User.Title
      description: The title of the user.
      type: string
    - contextPath: SalesForce.User.Phone
      description: The phone number of the user.
      type: string
    - contextPath: SalesForce.User.Email
      description: The email of the user.
      type: string
    description: Updates object fields.
    execution: true
  - name: salesforce-create-object
    arguments:
    - name: path
      required: true
      description: 'The object path. For example, "Case" for Object "Case".'
    - name: json
      required: true
      description: The JSON file with fields and values of the object to be created.
    outputs:
    - contextPath: SalesForce.Case.ID
      description: The Object ID of the case.
      type: string
    - contextPath: SalesForce.Case.CaseNumber
      description: The case number.
      type: string
    - contextPath: SalesForce.Case.Subject
      description: The subject of the case.
      type: string
    - contextPath: SalesForce.Case.Description
      description: The description of the case.
      type: string
    - contextPath: SalesForce.Case.CreateDate
      description: The creation date of the case.
      type: date
    - contextPath: SalesForce.Case.ClosedDate
      description: The closure date of the case.
      type: date
    - contextPath: SalesForce.Case.Owner
      description: The owner of the case.
      type: string
    - contextPath: SalesForce.Case.Priority
      description: 'The priority of the case. Can be: "Low", "Medium", "High".'
      type: string
    - contextPath: SalesForce.Case.Origin
      description: 'Origin of the Case. Can be: "Web", "Phone", or "Email".'
      type: string
    - contextPath: SalesForce.Case.Status
      description: 'The status of the case. Can be: "New", "Escalated", "On Hold", or "Closed".'
      type: string
    - contextPath: SalesForce.Case.Reason
      description: The reason for the case creation.
      type: string
    - contextPath: SalesForce.Contact.ID
      description: The ID of the contact.
      type: string
    - contextPath: SalesForce.Contact.Name
      description: The name of the contact.
      type: string
    - contextPath: SalesForce.Contact.Account
      description: The account associated with the Contact information.
      type: string
    - contextPath: SalesForce.Contact.Title
      description: The title of the contact.
      type: string
    - contextPath: SalesForce.Contact.Phone
      description: The phone number of the contact.
      type: string
    - contextPath: SalesForce.Contact.MobliePhone
      description: The mobile number of the contact.
      type: string
    - contextPath: SalesForce.Contact.Email
      description: The email of the contact.
      type: string
    - contextPath: SalesForce.Contact.Owner
      description: The owner of the contact.
      type: string
    - contextPath: SalesForce.Lead.ID
      description: The Lead ID.
      type: string
    - contextPath: SalesForce.Lead.Name
      description: The Lead name.
      type: string
    - contextPath: SalesForce.Lead.Title
      description: The Lead title.
      type: string
    - contextPath: SalesForce.Lead.Company
      description: The Lead company.
      type: string
    - contextPath: SalesForce.Lead.Phone
      description: The Lead phone number.
      type: string
    - contextPath: SalesForce.Lead.Mobile
      description: The Lead mobile number.
      type: string
    - contextPath: SalesForce.Lead.Email
      description: The Lead email.
      type: string
    - contextPath: SalesForce.Lead.Owner
      description: The Lead owner.
      type: string
    - contextPath: SalesForce.Lead.Status
      description: 'The Lead status. Can be: "New", "Nurturing", "Working", "Qualified", or "Unqualified".'
      type: string
    - contextPath: SalesForce.Task.ID
      description: The ID of the task.
      type: string
    - contextPath: SalesForce.Task.Subject
      description: The subject of the task.
      type: string
    - contextPath: SalesForce.Task.Lead
      description: The leader of the task.
      type: string
    - contextPath: SalesForce.Task.RelatedTo
      description: The relevant account of the task.
      type: string
    - contextPath: SalesForce.Task.DueDate
      description: The due date of the task.
      type: date
    - contextPath: SalesForce.User.ID
      description: The ID of the user.
      type: string
    - contextPath: SalesForce.User.Name
      description: The name of the user.
      type: string
    - contextPath: SalesForce.User.Title
      description: The title of the user.
      type: string
    - contextPath: SalesForce.User.Phone
      description: The phone number of the user.
      type: string
    - contextPath: SalesForce.User.Email
      description: The email of the user.
      type: string
    description: Creates a new object.
    execution: true
  - name: salesforce-push-comment
    arguments:
    - name: oid
      required: true
      description: The Object ID of subject.
    - name: text
      required: true
      description: Chat text.
    - name: link
      description: Adds a link to the message.
    outputs:
    - contextPath: SalesForce.Comment.Body
      description: The body of the comment.
      type: string
    - contextPath: SalesForce.Comment.CreatedDate
      description: The created date of the comment.
      type: date
    - contextPath: SalesForce.Comment.Title
      description: The title of the comment.
      type: string
    - contextPath: SalesForce.Comment.ParentType
      description: The parent type of the comment.
      type: string
    - contextPath: SalesForce.Comment.ParentName
      description: The parent name of the comment.
      type: string
    - contextPath: SalesForce.Comment.URL
      description: The URL link of the comment.
      type: string
    - contextPath: SalesForce.Comment.Visibility
      description: The visibility of the comment.
      type: string
    description: Adds a comment to Chatter.
  - name: salesforce-get-case
    arguments:
    - name: oid
      description: The Object ID of the case.
    - name: caseNumber
      description: Case number of case.
    outputs:
    - contextPath: SalesForce.Case.ID
      description: The Object ID of the case.
      type: string
    - contextPath: SalesForce.Case.CaseNumber
      description: The case number.
      type: string
    - contextPath: SalesForce.Case.Subject
      description: The subject of the case.
      type: string
    - contextPath: SalesForce.Case.Description
      description: The description of the case.
      type: string
    - contextPath: SalesForce.Case.CreateDate
      description: The creation date of the case.
      type: date
    - contextPath: SalesForce.Case.ClosedDate
      description: The closure date of the case.
      type: date
    - contextPath: SalesForce.Case.Owner
      description: The owner of the case.
      type: string
    - contextPath: SalesForce.Case.Priority
      description: 'The priority of the case. Can be: "Low", "Medium", or "High".'
      type: string
    - contextPath: SalesForce.Case.Origin
      description: 'The origin of the case. Can be: "Web", "Phone", or "Email".'
      type: string
    - contextPath: SalesForce.Case.Status
      description: 'The status of the case. Can be: "New", "Escalated", "On Hold", or "Closed".'
      type: string
    - contextPath: SalesForce.Case.Reason
      description: The reason for the case creation.
      type: string
    description: Returns information on a case. All arguments are optional, but you must specify at least one for the command to execute successfully.
  - name: salesforce-create-case
    arguments:
    - name: subject
      required: true
      default: true
      description: The case subject.
    - name: description
      description: The case description.
    - name: status
      required: true
      auto: PREDEFINED
      predefined:
      - New
      - On Hold
      - Closed
      - Escalated
      description: 'The Case Status. Can be: "New", "On Hold", "Closed", or "Escalated". Default is New.'
      defaultValue: New
    - name: origin
      auto: PREDEFINED
      predefined:
      - Email
      - Phone
      - Web
      description: 'The case origin. Can be: "Email", "Phone", or "Web".'
    - name: priority
      auto: PREDEFINED
      predefined:
      - Low
      - Medium
      - High
      description: 'The case priority. Can be: "Low", "Medium", or "High".'
      defaultValue: Low
    - name: type
      auto: PREDEFINED
      predefined:
      - Question
      - Problem
      - Feature Request
      description: 'The case type. Can be: "Question", "Problem", or "Feature Request".'
    outputs:
    - contextPath: SalesForce.Case.ID
      description: The Object ID of the case.
      type: string
    - contextPath: SalesForce.Case.CaseNumber
      description: The case number.
      type: string
    - contextPath: SalesForce.Case.Subject
      description: The subject of the case.
      type: string
    - contextPath: SalesForce.Case.Description
      description: The description of the case.
      type: string
    - contextPath: SalesForce.Case.CreateDate
      description: The creation date of the case.
      type: date
    - contextPath: SalesForce.Case.ClosedDate
      description: The closure date of the case.
      type: date
    - contextPath: SalesForce.Case.Owner
      description: The owner of the case.
      type: string
    - contextPath: SalesForce.Case.Priority
      description: 'The priority of the case. Can be: "Low", "Medium", or "High".'
      type: string
    - contextPath: SalesForce.Case.Origin
      description: 'The origin of the case. Can be: "Web", "Phone", or "Email".'
      type: string
    - contextPath: SalesForce.Case.Status
      description: 'The status of the case. Can be: "New", "Escalated", "On Hold", or "Closed".'
      type: string
    - contextPath: SalesForce.Case.Reason
      description: The reason for the case creation.
      type: string
    description: Creates a new case.
  - name: salesforce-update-case
    arguments:
    - name: oid
      description: The Object ID of the case.
    - name: caseNumber
      description: The case number.
    - name: subject
      description: The case subject.
    - name: description
      description: The case description.
    - name: status
      auto: PREDEFINED
      predefined:
      - New
      - On Hold
      - Closed
      - Escalated
      description: 'The case status. Can be: "New", "On Hold", "Closed", or "Escalated".'
    - name: origin
      auto: PREDEFINED
      predefined:
      - Email
      - Phone
      - Web
      description: 'The case origin. Can be: "Email", "Phone", or "Web".'
    - name: priority
      auto: PREDEFINED
      predefined:
      - Low
      - Medium
      - High
      description: 'The case priority. Can be: "Low", "Medium", or "High".'
    - name: type
      auto: PREDEFINED
      predefined:
      - Question
      - Problem
      - Feature Request
      description: 'The case type. Can be: "Question", "Problem", or "Feature Request".'
    outputs:
    - contextPath: SalesForce.Case.ID
      description: The Object ID of the case.
      type: string
    - contextPath: SalesForce.Case.CaseNumber
      description: The number of the case.
      type: string
    - contextPath: SalesForce.Case.Subject
      description: The subject of the case.
      type: string
    - contextPath: SalesForce.Case.Description
      description: The description of the case.
      type: string
    - contextPath: SalesForce.Case.CreateDate
      description: The creation date of the case.
      type: date
    - contextPath: SalesForce.Case.ClosedDate
      description: The closure date of the case.
      type: date
    - contextPath: SalesForce.Case.Owner
      description: The owner of the case.
      type: string
    - contextPath: SalesForce.Case.Priority
      description: 'The priority of the case. Can be: "Low", "Medium", or "High".'
      type: string
    - contextPath: SalesForce.Case.Origin
      description: 'Origin of the Case. Can be: "Web", "Phone", or "Email".'
      type: string
    - contextPath: SalesForce.Case.Status
      description: 'The status of the case. Can be: "New, "Escalated", "On Hold", or "Closed".'
      type: string
    - contextPath: SalesForce.Case.Reason
      description: Reason for the case creation.
      type: string
    description: Updates case fields.
  - name: salesforce-get-cases
    arguments: []
    description: Returns all cases.
  - name: salesforce-close-case
    arguments:
    - name: oid
      description: The case Object ID.
    - name: caseNumber
      description: The case number.
    outputs:
    - contextPath: SalesForce.Case.ID
      description: The Object ID of the case.
      type: string
    - contextPath: SalesForce.Case.CaseNumber
      description: The case number.
      type: string
    - contextPath: SalesForce.Case.Subject
      description: The subject of the case.
      type: string
    - contextPath: SalesForce.Case.Description
      description: Case Description.
      type: string
    - contextPath: SalesForce.Case.CreateDate
      description: Creation Time of Case.
      type: date
    - contextPath: SalesForce.Case.ClosedDate
      description: Closure Time of Case.
      type: date
    - contextPath: SalesForce.Case.Owner
      description: Case Owner.
      type: string
    - contextPath: SalesForce.Case.Priority
      description: Priority of the Case. one of Low, Medium, High.
      type: string
    - contextPath: SalesForce.Case.Origin
      description: Origin of the Case. one of Web, Phone, Email.
      type: string
    - contextPath: SalesForce.Case.Status
      description: 'Case Status. one of the following: New, Escalated, On Hold or Closed.'
      type: string
    - contextPath: SalesForce.Case.Reason
      description: Reason for case creation.
      type: string
    important:
    - contextPath: SalesForce.Case.Status
      description: Case Status. Will be 'Closed'.
      related: ""
    description: Close a case
  - name: salesforce-push-comment-threads
    arguments:
    - name: id
      required: true
      description: The Chatter comment Thread ID.
    - name: text
      required: true
      description: The comment text.
    outputs:
    - contextPath: SalesForce.Comment.Reply.Body
      description: Reply body.
      type: string
    - contextPath: SalesForce.Comment.Reply.CreatedDate
      description: Reply created date.
      type: date
    - contextPath: SalesForce.Comment.Reply.URL
      description: Reply URL link.
      type: string
    description: Add the comment to the chatter thread. Use this command only after salesforce-push-comment
  - name: salesforce-delete-case
    arguments:
    - name: oid
      description: The Object ID of the case.
    - name: caseNumber
      description: The case number.
    description: Deletes a case.
  - name: salesforce-file-delete
    execution: true
    arguments:
    - name: type
      description: The Salesforce sObject type.
      defaultValue: ContentDocument
    - name: id
      description: The ContentDocument record ID to delete.
      required: true
    - name: ignore_not_found
      description: Whether to treat a 404/NOT_FOUND response as success.
      auto: PREDEFINED
      predefined:
      - "true"
      - "false"
      defaultValue: "true"
    description: Soft-deletes a file (ContentDocument), moving it to the Recycle Bin and cascading to its versions. Recoverable for 15 days.
    outputs:
    - contextPath: SalesForce.Remediation.Action
      description: The remediation action performed.
      type: string
    - contextPath: SalesForce.Remediation.ObjectType
      description: The Salesforce sObject type acted on.
      type: string
    - contextPath: SalesForce.Remediation.Id
      description: The record ID acted on.
      type: string
    - contextPath: SalesForce.Remediation.Status
      description: The result status of the remediation action.
      type: string
  - name: salesforce-knowledge-article-archive
    arguments:
    - name: type
      description: The Salesforce sObject type.
      defaultValue: KnowledgeArticleVersion
    - name: id
      description: The Knowledge article version ID (the __kav record ID, starting with 'ka') to archive.
      required: true
    - name: ignore_not_found
      description: Whether to treat a 404/NOT_FOUND response as success.
      auto: PREDEFINED
      predefined:
      - "true"
      - "false"
      defaultValue: "true"
    description: Archives a Knowledge article (non-destructive). Sets PublishStatus to Archived via the standard archiveKnowledgeArticles action. Reversible to Draft/Online.
    outputs:
    - contextPath: SalesForce.Remediation.Action
      description: The remediation action performed.
      type: string
    - contextPath: SalesForce.Remediation.ObjectType
      description: The Salesforce sObject type acted on.
      type: string
    - contextPath: SalesForce.Remediation.Id
      description: The record ID acted on.
      type: string
    - contextPath: SalesForce.Remediation.Status
      description: The result status of the remediation action.
      type: string
  - name: salesforce-file-public-link-list
    arguments:
    - name: id
      description: The ContentDocument record ID whose public links (ContentDistribution rows) should be listed.
      required: true
    description: Lists all public links (ContentDistribution records) for a given ContentDocument ID. Use the returned ContentDistribution IDs with salesforce-file-public-link-remove to remove each link.
    outputs:
    - contextPath: SalesForce.ContentDistribution.Id
      description: The ContentDistribution record ID (use with salesforce-file-public-link-remove).
      type: string
    - contextPath: SalesForce.ContentDistribution.ContentDocumentId
      description: The parent ContentDocument ID.
      type: string
    - contextPath: SalesForce.ContentDistribution.Name
      description: The name of the content distribution.
      type: string
    - contextPath: SalesForce.ContentDistribution.PublicUrl
      description: The public distribution URL.
      type: string
  - name: salesforce-file-public-link-remove
    execution: true
    arguments:
    - name: type
      description: The Salesforce sObject type.
      defaultValue: ContentDistribution
    - name: id
      description: The ContentDistribution record ID to delete (severs the public link). Use salesforce-file-public-link-list to obtain distribution IDs for a ContentDocument.
      required: true
    - name: ignore_not_found
      description: Whether to treat a 404/NOT_FOUND response as success.
      auto: PREDEFINED
      predefined:
      - "true"
      - "false"
      defaultValue: "true"
    description: Removes a file public link by deleting a single ContentDistribution record. The external link is severed immediately and irreversibly.
    outputs:
    - contextPath: SalesForce.Remediation.Action
      description: The remediation action performed.
      type: string
    - contextPath: SalesForce.Remediation.ObjectType
      description: The Salesforce sObject type acted on.
      type: string
    - contextPath: SalesForce.Remediation.Id
      description: The ContentDistribution record ID acted on.
      type: string
    - contextPath: SalesForce.Remediation.Status
      description: The result status of the remediation action.
      type: string
  - name: salesforce-knowledge-article-draft-create
    arguments:
    - name: type
      description: The Salesforce sObject type.
      defaultValue: KnowledgeArticleVersion
    - name: id
      description: The Knowledge article ID (KnowledgeArticleId, starting with 'kA') or article version ID (starting with 'ka'). Used with the standard createDraftFromOnlineKnowledgeArticle action.
      required: true
    - name: unpublish
      description: Whether to archive the current online version (removing it from public visibility) and create a new draft. If false, keeps the article online and creates an editable draft alongside it.
      auto: PREDEFINED
      predefined:
      - "true"
      - "false"
      defaultValue: "true"
    - name: ignore_not_found
      description: Whether to treat a 404/NOT_FOUND response as success.
      auto: PREDEFINED
      predefined:
      - "true"
      - "false"
      defaultValue: "true"
    description: Moves a published Knowledge article to Draft using the standard createDraftFromOnlineKnowledgeArticle action. By default (unpublish=true) the online version is removed from public visibility and an editable draft is created.
    outputs:
    - contextPath: SalesForce.Remediation.Action
      description: The remediation action performed.
      type: string
    - contextPath: SalesForce.Remediation.ObjectType
      description: The Salesforce sObject type acted on.
      type: string
    - contextPath: SalesForce.Remediation.Id
      description: The record ID acted on.
      type: string
    - contextPath: SalesForce.Remediation.Status
      description: The result status of the remediation action.
      type: string
    - contextPath: SalesForce.Remediation.Unpublished
      description: Whether the online version was unpublished (removed from public visibility).
      type: boolean
    - contextPath: SalesForce.Remediation.DraftVersionId
      description: The ID of the newly created draft article version.
      type: string
  - name: salesforce-get-casecomment
    arguments:
    - name: oid
      description: Returns information of a case.
    - name: caseNumber
      description: The case number of the case.
    outputs:
    - contextPath: ID
      description: The ID of the case.
      type: string
    - contextPath: ParentId
      description: The ID of the parent case of the case comment. Required.
      type: string
    - contextPath: IsPublished
      description: Whether the case comment is visible to customers in the Self-Service portal (true). The label is published. This is the only CaseComment field that can be updated through the API.
      type: boolean
    - contextPath: CommentBody
      description: The text of the case body. Maximum size is 4,000 bytes. The label is Body.
      type: string
    - contextPath: CreatedById
      description: 'The created date by ID.'
    - contextPath: CreatedDate
      description: The created date.
      type: string
    - contextPath: SystemModstamp
      description: 'The SystemMod stamp.'
      type: string
    - contextPath: LastModifiedDate
      description: 'The last modified date. '
      type: string
    - contextPath: LastModifiedById
      description: 'The last modified date by ID.'
      type: string
    - contextPath: IsDeleted
      description: Whether the object has been moved to the Recycle Bin (true). Label is Deleted.
      type: boolean
    description: Returns a comment through the case number.
  - name: salesforce-post-casecomment
    arguments:
    - name: oid
      description: The Object ID of the case.
    - name: caseNumber
      description: The case number of the case.
    - name: text
      description: Added Text to context.
    description: The post comment through the case number.
  - name: salesforce-get-user
    arguments:
    - name: oid
      description: The Object ID of the case.
    - name: caseNumber
      description: The case number of the case.
    outputs:
    - contextPath: ID
      description: The ID of the case.
      type: string
    - contextPath: Alias
      description: The user’s alias. Required. For example, jsmith.
      type: string
    - contextPath: CommunityNickname
      description: The name used to identify the user in the Community application, which includes the ideas and answers features.
      type: string
    - contextPath: CreatedById
      description: 'Created by the ID.'
      type: string
    - contextPath: Email
      description: The user’s email address. Required.
      type: string
    - contextPath: LastLoginDate
      description: The time and date when the user last successfully logged in. This value is updated if 60 seconds have elapsed since the user’s last login.
      type: string
    - contextPath: LastModifiedDate
      description: The last modified date.
      type: string
    - contextPath: LastName
      description: The user’s last name. Required.
      type: string
    - contextPath: Name
      description: Concatenation of FirstName and LastName. Limited to 121 characters.
      type: string
    - contextPath: Username
      description: Contains the name that a user enters to log in to the API or the user interface. Required. Must be in the form of an email address, all characters should be lowercase, and unique across all organizations. Each added user counts as a license. Every organization has a maximum number of licenses. If you attempt to exceed the maximum number of licenses by inserting user records, the attempt to create a user is rejected.
      type: string
    - contextPath: UserRoleId
      description: The ID of the user’s UserRole. Label is Role ID.
      type: string
    description: Returns the UserName through the case number.
  - name: salesforce-get-org
    arguments:
    - name: caseNumber
      description: The case number of the case.
    outputs:
    - contextPath: ID
      description: The unique ID of the case.
      type: string
    - contextPath: Name
      description: 'Name of the account. Required. Label is Account Name. Maximum size is 255 characters. If the account has a record type of Person Account, this value is the concatenation of the FirstName, MiddleName, LastName, and Suffix of the associated person contact. You cannot modify this value.'
      type: string
    description: 'Returns organization details from the case number. '
  isfetch: true
fromversion: 5.0.0
tests:
- SalesforceTestPlaybook