On this page
Connect
1
Log in as a Salesforce admin and go to Setup
You need permissions to access Platform Tools on Salesforce in the Setup page.
2
Open External Client App Manager
Navigate to 
Apps → External Client Apps → External Client App Manager3
Create a new External Client App
4
Fill out the necessary information
- Enter a Name (for example, “Typewise OAuth”)
- Provide your preferred Email address
- You can leave the rest of the basic information blank
-
Under API →
Enable OAuth - Enter a random callback URL (this won’t be used)
-
Select and add the necessary scopes. Make sure to add the
apiscope. -
Make sure
Enable Client Credentials Flowis selected -
Ensure all other checkboxes are disabled
Create to create the client.5
Enable client credentials flow and assign user
After creating the new app:
- Navigate to the newly created app
- Under policies, enable client credentials flow
-
Assign a user to run as (this user will be attributed to all actions/reads performed by this app)
6
View and share the generated credentials
You’ll need the consumer key and secret to enable the integration.
Supported tools
The following tools are available through the Salesforce integration.Lookups
get_case_by_id
get_case_by_id
Retrieve all fields of a Salesforce case by its ID.
| Parameter | Description | Required | Default |
|---|---|---|---|
case_id | The ID of the case to retrieve. | Yes | — |
get_case_description_by_id
get_case_description_by_id
Retrieve only the
Description field of a Salesforce case by its ID.| Parameter | Description | Required | Default |
|---|---|---|---|
case_id | The ID of the case to query. | Yes | — |
get_customer_details
get_customer_details
Retrieve customer details including name, email, phone, and mailing address.
| Parameter | Description | Required | Default |
|---|---|---|---|
user_email | Email address of the customer to retrieve details for. | Yes | — |
get_all_open_tickets
get_all_open_tickets
Get all open Salesforce cases for a customer (excluding
Closed / Resolved).| Parameter | Description | Required | Default |
|---|---|---|---|
user_email | Email address of the customer to retrieve tickets for. | Yes | — |
limit | Maximum number of results to return. | No | 100 |
get_ticket_status
get_ticket_status
Get the status and key information of a Salesforce case.
| Parameter | Description | Required | Default |
|---|---|---|---|
case_identifier | The Case ID (starts with 500) or Case Number to look up. | Yes | — |
Actions
update_customer_details
update_customer_details
Update a customer’s Salesforce Contact fields. You must provide
user_email and at least one field to update.| Parameter | Description | Required | Default |
|---|---|---|---|
user_email | Email address of the customer to update. | Yes | — |
first_name | First name. | No | — |
last_name | Last name. | No | — |
phone | Primary phone number. | No | — |
mobile_phone | Mobile phone number. | No | — |
mailing_street | Mailing street address. | No | — |
mailing_city | Mailing city. | No | — |
mailing_state | Mailing state or province. | No | — |
mailing_postal_code | Mailing postal or ZIP code. | No | — |
mailing_country | Mailing country. | No | — |
create_customer_profile
create_customer_profile
Create a new customer profile (Contact) in Salesforce.
| Parameter | Description | Required | Default |
|---|---|---|---|
user_email | Email address for the new customer profile. | Yes | — |
last_name | Customer’s last name. | Yes | — |
first_name | Customer’s first name. | No | — |
phone | Primary phone number. | No | — |
mobile_phone | Mobile phone number. | No | — |
mailing_street | Mailing street address. | No | — |
mailing_city | Mailing city. | No | — |
mailing_state | Mailing state/province. | No | — |
mailing_postal_code | Mailing postal/ZIP code. | No | — |
mailing_country | Mailing country. | No | — |
write_post_to_ticket
write_post_to_ticket
Write a comment to an existing Salesforce case.
| Parameter | Description | Required | Default |
|---|---|---|---|
case_identifier | The Case ID (starts with 500) or Case Number to add a comment to. | Yes | — |
comment_text | The comment text to add. | Yes | — |
is_public | Whether the comment should be public. | No | true |