Salesforce Create New Account

plugins/salesforce-create-account/.codeblocks/block_0.sh

@@ -2,9 +2,9 @@ curl --location 'https://<YOUR_DOMAIN>/services/data/v62.0/sobjects/Account/' \
 --header 'Authorization: Bearer' \
 --header 'Content-Type: application/json' \
 --data '{
-  "Name" : ":<Account_Name>",
-  "BillingStreet": "<Billing_Streeet>",
-  "BillingCity": "<Billing_City>",
-  "BillingState": "<Billing_state>",
-  "BillingCountry": "<BillingCountry"
+"Name" : ":<Account_Name>",
+"BillingStreet": "<Billing_Streeet>",
+"BillingCity": "<Billing_City>",
+"BillingState": "<Billing_state>",
+"BillingCountry": "<BillingCountry>"
 }'

plugins/salesforce-create-account/README.md

@@ -12,173 +12,50 @@ systems:
 time_in_minutes: 15
 ---
 
-# Plugin to create account in salesforce
+# **Introduction:**
 
-# Introduction
+The **Salesforce Create Account** plugin enables users to seamlessly create and manage new account records in Salesforce directly through the Moveworks AI Assistant. This streamlined process eliminates manual data entry, saving time and ensuring accuracy.
 
-Salesforce is a CRM platform, and the "Create account in Salesforce" plugin streamlines adding new contacts to your Salesforce account. By integrating this feature with your bot, users can easily create and manage contacts, improving efficiency and organization.
+This guide will walk you through the installation and configuration of the plugin in Agent Studio, allowing you to automate account creation effortlessly. Let’s begin!
 
-This guide will show you how to add the "Create account in Salesforce" feature to your bot using Creator Studio. Let's get started!
+# **Prerequisites :**
 
-# Prerequisites
+- Access to Agent Studio
 
-- [Postman](https://www.postman.com/) or an API Testing Tool
-- Salesforce Connector built in Creator Studio (follow the [Salesforce Authentication](https://developer.moveworks.com/creator-studio/resources/connector/?id=salesforce) guide to create your connector)
+# **What are we building?**
 
-# What are we building?
+### **Agent Design**
 
-### **Conversation Design**
+This [purple chat](ttps://developer.moveworks.com/creator-studio/developer-tools/purple-chat?conversation=%7B%22startTimestamp%22%3A%2211%3A43+AM%22%2C%22messages%22%3A%5B%7B%22parts%22%3A%5B%7B%22richText%22%3A%22I+need+to+create+a+new+account+in+Salesforce%2C+the+name+is+ABC+Corp+and+their+address+is+1234+Main+Street%2C+San+Jose%2C+CA+95123%22%7D%5D%2C%22role%22%3A%22user%22%7D%2C%7B%22parts%22%3A%5B%7B%22richText%22%3A%22Sure%2C+I+can+help+with+that.+To+confirm%2C+are+you+the+owner+of+the+account%22%7D%5D%2C%22role%22%3A%22assistant%22%7D%2C%7B%22parts%22%3A%5B%7B%22richText%22%3A%22Yes%22%7D%5D%2C%22role%22%3A%22user%22%7D%2C%7B%22parts%22%3A%5B%7B%22richText%22%3A%22Okay%2C+I+can+create+the+account+with+the+following+details%3A%5Cn%22%7D%2C%7B%22richText%22%3A%22%3Cb%3E%3Cp%3EPlease+confirm+the+account+details%3Cbr%3E%3C%2Fp%3E%3C%2Fb%3E%3Cbr%3E%3Cp%3E%3Cb%3EAccount+Name%3A%3C%2Fb%3E+ABC+Corp%3Cbr%3E%3Cb%3EAddress%3A%3C%2Fb%3E+1234+Main+Street%2C+San+Jose+CA+95123%3Cbr%3E%3Cb%3EAccount+Owner%3A+%3C%2Fb%3EGwen%3C%2Fp%3E%22%7D%2C%7B%22buttons%22%3A%5B%7B%22buttonText%22%3A%22Create+Account+in+Salesforce%22%2C%22style%22%3A%22filled%22%7D%2C%7B%22buttonText%22%3A%22Edit+Details%22%2C%22style%22%3A%22outlined%22%7D%2C%7B%22buttonText%22%3A%22Cancel%22%2C%22style%22%3A%22outlined%22%7D%5D%7D%5D%2C%22role%22%3A%22assistant%22%7D%2C%7B%22parts%22%3A%5B%7B%22reasoningSteps%22%3A%5B%7B%22richText%22%3A%22Creating+ABC+Corp+Account+in+Salesforce...%22%2C%22status%22%3A%22pending%22%7D%5D%7D%2C%7B%22richText%22%3A%22I+created+the+account%21%22%7D%2C%7B%22citations%22%3A%5B%7B%22citationTitle%22%3A%22ABC+Corp%22%2C%22connectorName%22%3A%22salesforce%22%7D%5D%7D%5D%2C%22role%22%3A%22assistant%22%7D%5D%7D) shows the experience we are going to build.
 
-This [purple chat](https://developer.moveworks.com/creator-studio/developer-tools/purple-chat?conversation=%7B%22startTimestamp%22%3A%2211%3A43+AM%22%2C%22messages%22%3A%5B%7B%22parts%22%3A%5B%7B%22richText%22%3A%22I+need+to+create+a+new+account+in+Salesforce%2C+the+name+is+ABC+Corp+and+their+address+is+1234+Main+Street%2C+San+Jose%2C+CA+95123%22%7D%5D%2C%22role%22%3A%22user%22%7D%2C%7B%22parts%22%3A%5B%7B%22richText%22%3A%22Sure%2C+I+can+help+with+that.+To+confirm%2C+are+you+the+owner+of+the+account%22%7D%5D%2C%22role%22%3A%22assistant%22%7D%2C%7B%22parts%22%3A%5B%7B%22richText%22%3A%22Yes%22%7D%5D%2C%22role%22%3A%22user%22%7D%2C%7B%22parts%22%3A%5B%7B%22richText%22%3A%22Okay%2C+I+can+create+the+account+with+the+following+details%3A%5Cn%22%7D%2C%7B%22richText%22%3A%22%3Cb%3E%3Cp%3EPlease+confirm+the+account+details%3Cbr%3E%3C%2Fp%3E%3C%2Fb%3E%3Cbr%3E%3Cp%3E%3Cb%3EAccount+Name%3A%3C%2Fb%3E+ABC+Corp%3Cbr%3E%3Cb%3EAddress%3A%3C%2Fb%3E+1234+Main+Street%2C+San+Jose+CA+95123%3Cbr%3E%3Cb%3EAccount+Owner%3A+%3C%2Fb%3EGwen%3C%2Fp%3E%22%7D%2C%7B%22buttons%22%3A%5B%7B%22buttonText%22%3A%22Create+Account+in+Salesforce%22%2C%22style%22%3A%22filled%22%7D%2C%7B%22buttonText%22%3A%22Edit+Details%22%2C%22style%22%3A%22outlined%22%7D%2C%7B%22buttonText%22%3A%22Cancel%22%2C%22style%22%3A%22outlined%22%7D%5D%7D%5D%2C%22role%22%3A%22assistant%22%7D%2C%7B%22parts%22%3A%5B%7B%22reasoningSteps%22%3A%5B%7B%22richText%22%3A%22Creating+ABC+Corp+Account+in+Salesforce...%22%2C%22status%22%3A%22pending%22%7D%5D%7D%2C%7B%22richText%22%3A%22I+created+the+account%21%22%7D%2C%7B%22citations%22%3A%5B%7B%22citationTitle%22%3A%22ABC+Corp%22%2C%22connectorName%22%3A%22salesforce%22%7D%5D%7D%5D%2C%22role%22%3A%22assistant%22%7D%5D%7D) shows the experience we are going to build.
+# **Installation Steps**
 
+While you can create a connector during plugin installation, we recommend creating a connector in **Agent Studio** beforehand to streamline the process. Please follow our [Salesforce Connector](https://developer.moveworks.com/marketplace/package/?id=salesforce&hist=home) Guide to do so. Once completed, follow our plugin installation documentation to install the **Create Account** plugin in minutes.
 
-# Creator Studio Components
+## **Required Permissions:**
 
-- **Triggers:**
-    1. **Natural Language**
-    2. Identify user queries or commands related to creating a account in Salesforce.
-- **Slots:**
-    1. **User Information:** Extract and store key details such as the account's name, email address, phone number, and associated account name**.**
-- **Actions:**
-    1. **Create Account:** Fetch all the details required to create an account including account name. billing city, billing country etc. 
-- **Guidelines:**
-    1. **Create  Salesforce Account:**
-
-        Create a new record within a specific Salesforce account by capturing details such as name,  and address, and link the contact to the selected Salesforce account for streamlined customer management
-
+- **Read**
+    - Access to the **Account** object
+- **Edit**
+    - Ability to modify **Account** fields post-creation
 
-# API Research
+After configuring the connector, refer to our [plugin installation documentation](https://help.moveworks.com/docs/ai-agent-marketplace-installation) for more details on completing the setup
 
-To build this use case, we will use one **API** to achieve the goal of creating a Salesforce account:
+# **Appendix**
 
-![Screenshot 2025-01-07 at 6.40.52 PM.png](images/Screenshot_2025-01-07_at_6.40.52_PM.png)
+## API #1: Create Account.
 
-## API #1:Creating a Salesforce Account.
-
-The API is used to [create a salesforce account](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_sobject_create.htm)  you supply the required field values in the request data, and send the request using the POST HTTP method.
-
-```bash
-curl --location 'https://<YOUR_DOMAIN>/services/data/v62.0/sobjects/Account/' \
---header 'Authorization: Bearer' \
---header 'Content-Type: application/json' \
---data '{
-  "Name" : ":<Account_Name>",
-  "BillingStreet": "<Billing_Streeet>",
-  "BillingCity": "<Billing_City>",
-  "BillingState": "<Billing_state>",
-  "BillingCountry": "<BillingCountry"
-}'
-```
-
-# Steps
-
-## **Step 1: Build HTTP Action**
-
-Define your HTTP Actions for fetching the **Account ID** from Salesforce based on the provided **Account Name**.
-
-1. **In Creator Studio, Create a New Action**:
-
-- Navigate to **Plugins** section > **Actions** tab.
-- Click on **CREATE** to define a new action.
-
-![Screenshot 2025-01-07 at 7.14.13 PM.png](images/Screenshot_2025-01-07_at_7.14.13_PM.png)
-
-Click on the `IMPORT CURL` option and paste the following cURL command:
+The Create Account API is used to create a account in salesforce. 
 
 ```bash
 curl --location 'https://<YOUR_DOMAIN>/services/data/v62.0/sobjects/Account/' \
 --header 'Authorization: Bearer' \
 --header 'Content-Type: application/json' \
 --data '{
-  "Name" : ":<Account_Name>",
-  "BillingStreet": "<Billing_Streeet>",
-  "BillingCity": "<Billing_City>",
-  "BillingState": "<Billing_state>",
-  "BillingCountry": "<BillingCountry"
+"Name" : ":<Account_Name>",
+"BillingStreet": "<Billing_Streeet>",
+"BillingCity": "<Billing_City>",
+"BillingState": "<Billing_state>",
+"BillingCountry": "<BillingCountry>"
 }'
-```
-
-- Click on `Use Existing Connector` > select the [Salesforce](https://developer.moveworks.com/creator-studio/resources/connector/?id=salesforce) [**connector**](https://developer.moveworks.com/creator-studio/resources/connector/?id=jira) that you just created > Click on `Apply`. This will populate the Base URL and the Authorization section of the API Editor.
-
-- To create a **Account** in Salesforce, we send a **POST** request with the following body:
-    - Name: Name of the account you want to create
-    - BillingStreet: The name of the street where the company is located.
-    - BillingCity: The name of the street where the company is located.
-    - BillingState: The name of the state where the company is located.
-    - BillingCountry: The name of the country where the company is located.
-
-![Screenshot 2025-01-08 at 9.38.20 AM.png](images/Screenshot_2025-01-08_at_9.38.20_AM.png)
-
-![Screenshot 2025-01-08 at 9.57.02 AM.png](images/Screenshot_2025-01-08_at_9.57.02_AM.png)
-
-We have provided sample input variables for **Account Name,Billing city,Billing country,Billing state, Billing street** Using these input variables, we tested the plugin by making a **POST** request to create a A**ccount** in Salesforce.
-
-![Screenshot 2025-01-08 at 10.02.05 AM.png](images/Screenshot_2025-01-08_at_10.02.05_AM.png)
-
-After that, you can test the plugin by checking the response. If the contact has been successfully created, the response will return a **201** status code, indicating successful creation of the contact, If the output schema is incorrect or missing, click `GENERATE FROM RESPONSE` to update it.
-
-![Screenshot 2025-01-08 at 10.10.13 AM.png](images/Screenshot_2025-01-08_at_10.10.13_AM.png)
-
-Add the **API Name** and **API Description** as shown below, then click the `Save` button.
-
-## **Step 2: Build Compound Action**
-
-- Head over to the **Compound Actions** tab and click **CREATE**
-
-![Screenshot 2025-01-08 at 10.06.43 AM.png](images/Screenshot_2025-01-08_at_10.06.43_AM.png)
-
-![Screenshot 2025-01-08 at 10.13.39 AM.png](images/Screenshot_2025-01-08_at_10.13.39_AM.png)
-
-Give your Compound Action a **Name** and **Description** , then click `Next` Note: Name only letters, numbers, and underscores. We suggest using snake case or camel case formatting (e.g. Workflow_name or workflowName )
-
-```yaml
-steps:
-  - action:
-      output_key: Create_Account_Salesforce_result
-      action_name: Create_Account_Salesforce
-      progress_updates:
-        on_complete: ON_COMPLETE_MESSAGE
-        on_pending: ON_PENDING_MESSAGE
-      input_args:
-        billing_country: data.billing_country
-        billing_city: data.billing_city
-        billing_state: data.billing_state
-        billing_street: data.billing_street
-        account_name: data.account_name
-```
-
-Click on the `Script editor` tab. Here you will be able to build your compound action using the YAML syntax. At a high-level, this syntax provides actions (HTTP Request, APIthon Scripts) and workflow logic (switch statements, for each loops, return statements, parallel, try/catch). See the [Compound Action Syntax](https://developer.moveworks.com/creator-studio/reference/compound_actions_syntax/) Reference for more info.
-
-![Screenshot 2025-01-08 at 10.16.19 AM.png](images/Screenshot_2025-01-08_at_10.16.19_AM.png)
-
-Click on `Input fields` tab and click the `+Add` button. Here you will define the slots that you want to collect from users through the conversation and trigger your Workflow with. After defining the input fields, click the `Submit` button to save your changes.
-
-## **Step 3: Publish Workflow to Plugin**
-
-- Head over to the `Compound Actions` tab and click on the kebab menu ( `︙` )
-- Next, click on `Publish Workflow to Plugin`
-- First, verify your Plugin **Name** & **Short description** . This is autofilled from the name & description of your compound action.
-
-![Screenshot 2025-01-08 at 10.19.55 AM.png](images/Screenshot_2025-01-08_at_10.19.55_AM.png)
-
-Next, consider whether to select the `User consent required before execution?` checkbox. Enabling this option prompts the user to confirm all slot values before executing the plugin, which is widely regarded as a best practice.
-
-![Screenshot 2025-01-08 at 10.21.44 AM.png](images/Screenshot_2025-01-08_at_10.21.44_AM.png)
-
-- Click `Next` and set up your positive and negative triggering examples. This ensures that the bot triggers your plugin given a relevant utterance.
-    - See our [guide](https://developer.moveworks.com/creator-studio/conversation-design/triggers/natural-language-triggers/#how-to-write-good-triggering-examples) on Triggering
-- Lastly, click `Next` and set the **Launch Rules** you want your plugin to abide by.
-    - See our [guide](https://developer.moveworks.com/creator-studio/administration/launch-options/) on Launch Rules
-
-## **Step 4: See it in action!**
-
-- After clicking the final `Submit` button, your plugin will be published to the bot and triggerable based on your **Launch Rules.**
-- You should wait up to **5 minutes** after making changes before trying to test in your bot!
-- If you run into an issue:
-    1. Check our [troubleshooting guides](https://developer.moveworks.com/creator-studio/troubleshooting/support/)
-    2. Understand your issue using Logs
-    3. Reach out to Support
-
-# **Congratulations!**
-
-You've just added the "Create Account" feature inside your Salesforce account to your Copilot! Explore our other guides for more ideas on what to build next.
+```