This template is for gathering requirements to integrate your webforms with your agency's Salesforce instance. Business Analysts or Delivery Managers should fill out this template and attach it to the relevant feature request.
Fill in this template for every webform
Each webform integration needs a separate feature request. For instance, if you have three webforms to integrate, you must complete this template for each one. Some information in this template can be reused and should be marked as such.
Before you start
Your Salesforce team must complete the following tasks and have this information ready:
- Set up the Salesforce forms to store webform data
- Set up a client with appropriate access to connect with your Salesforce instance.
General information
-
Agency Name: <Your agency's name>
- Contact Person: <Full name of the primary contact>
- Contact Email: <Email address of primary contact>
-
Project Name/ID: Salesforce Integration Project
- Brief Project Description: <Brief description on what kind of data your customer will submit to your agency’s Salesforce instance>
Salesforce instance information
Salesforce instance URL:
- Sandbox: https://xyzcorp.lightning.force.com
- Production: https://xyzcorp.lightning.force.com. This instance can be shared after user acceptance testing is complete on Sandbox instance.
Webform details
- Webform Location: https://nsw.gov.au/webform
-
Webform Approval:
- Confirm if the PIA for the webform is approved - Yes/No. If yes, add the Jira link/ID for the PIA approval.
- If the PIA is not approved, fill in the Privacy Enquiries form selecting Privacy Impact Assessment (PIA) as the enquiry type.
Webform to Salesforce mapping
Provide the mappings between webform and Salesforce fields as shown here.
| Web form field name | Webform key | Webform type | Required | Salesforce field name | Key | Type |
|---|---|---|---|---|---|---|
| Serial Number | serial | integer | yes | Serial Number | serial_number | Number |
| Submission ID | sid | integer | yes | Submission ID | submission_id | Number |
| Completed | completed | timestamp | yes | Date/Time completed | date_time_completed | Date/Time |
| Remote IP address | remote_addr | string | yes | Remote IP address | remote_ip_address | Text(255) |
| <Field 1> | field_1 | Text | yes | Field one | field_one | Text(255) |
| <Field n> | field_n | Text | no | Field Two | field_two | Text(255) |
* Highlighted fields are required for security and auditing purposes.
Access and permissions
-
Client Credentials: Client ID and secret to connect with Salesforce instance
- Non Prod:
- Prod:
- Authentication Method: OAuth 2.0 (Client Credentials Flow)
Testing and validation
Postman script: Share the Postman script used to verify the credentials and successful data submission to the Salesforce instance.
Additional information
-
Documentation:
- Authentication: OAuth 2.0 Client Credentials Flow for Server-to-Server Integration
- Creating records: Create Records Using sObject Collections
- Support: If your agency needs technical support in setting up the Salesforce form, send an email to our Platform team.
Need any more help?
If you have any questions, or require assistance with anything mentioned in this article, submit a request via the webform.