Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Cases / Case Get

  • Article
  • 3 minutes to read

Operation Information

Retrieves information about a Salesforce Case.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type oAuth 2.0.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose oAuth 2.0 in the Type pick list;
  • Give the oAuth 2.0 KeySafe key a Title (this is the name / identifier for the oAuth 2.0 account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
Client Id string Application Client Id
Client Secret string Application Client Secret
oAuth Scope string Application oAuth Scope
Authorize URL string Application Authorize URL
Access URL string Application Access UR
Response Type string Application Response Type
Additional Params string Application Additional Params
Additional Access Token Params string Application Additional Access Token Request Params
Grant Type string Application Grant Type
Refresh URL string Application Refresh URL
Refresh Grant Type string Application Refresh Grant Type
Refresh Body string Application Refresh Body
Revoke URL string Token Revoke URL
Token string Authentication Token
Refresh Token string Refresh Token
API Endpoint string Optional API Endpoint

Tip

Client ID and Client Secret should be populated with a valid Consumer Key and Consumer Secret. Values for the Authorize, Access, Refresh and Revoke URLs can be found on the Salesforce website.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked oAuth 2.0 account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Case Id id string Id for the Case Yes None provided
Instance instance string SalesForce Instance Name Yes None provided

Output Parameters

Display Name ID Type Description
Id id string Id of the case
Case Number caseNumber string User friendly case number
Contact Id contactId string Id of the contact related to the case
Account Id accountId string Id of the account related to the case
Web Name suppliedName string Name supplied via Email/Web Form
Web Email suppliedEmail string Email supplied via Email/Web Form
Web Phone suppliedPhone string Phone Number supplied via Email/Web Form
Web Company suppliedCompany string Company Name supplied via Email/Web Form
Type type string The type of the case
Status status string The Status of the case (e.g New, Working, Escalated, Closed)
Reason reason string Reason for the case (e.g. Performance, Breakdown, Feedback)
Origin origin string Origin of the case (Phone, Email, Web)
Subject subject string Subject of the case
Priority priority string Priority of the case (High, Medium, Low)
Description description string Description of the case
Owner Id ownerId string Id of the case owner
Date Created createdDate string Date Case created
Engineering Req Number engineeringReqNumber string Engineering Req Number
SLA Violation slaViolation string SLA Violation (Yes/No)
Product product string Product on the Case
Potential Liability potentialLiability string Potential Liability (Yes/No)
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document