Devdocs 16159 (#35)

karissarjacobsen · web-flow · commit fa3430408c6d · 2025-01-27T14:28:00.000-08:00
* Sample app rename
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2024 Docusign, Inc. (https://www.docusign.com)
+Copyright (c) 2025 Docusign, Inc. (https://www.docusign.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
-# Ruby on Rails and React: MyConnectWebhook Sample Application
+# Ruby on Rails and React: Webhooks Sample App
 
-### Github repo: MyConnectWebhookSampleApp
+### Github repo: Webhooks Sample App
 
 ## Introduction
-MyConnectWebhook is a Docusign sample application written in Ruby on Rails (server) and React (client). You can find a live instance running at [https://myconnectwebhook.sampleapps.docusign.com/](https://myconnectwebhook.sampleapps.docusign.com/).
+The Webhooks Sample App is a Docusign sample application written in Ruby on Rails (server) and React (client). You can find a live instance running at [https://webhooks.sampleapps.docusign.com/](https://webhooks.sampleapps.docusign.com/).
 
-MyConnectWebhook demonstrates the following:
+The Webhooks Sample App demonstrates the following:
 
 1. **Authentication** with Docusign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken).
 2. **Bulk sending multiple envelopes:** ([Source](./app/services/e_sign/bulk_sending_envelopes_service.rb))
@@ -37,13 +37,13 @@ MyConnectWebhook demonstrates the following:
 ## Installation steps
 
 ### Clone project
-Clone project into folder `./sample-app-myconnectwebhook-ruby`
+Clone project into folder `./sample-app-webhooks-ruby`
 ```
-git clone git@github.com:docusign/sample-app-myconnectwebhook-ruby.git
+git clone git@github.com:docusign/sample-app-webhooks-ruby.git
 ```
 ### Run command to move to project folder
 ```
-cd sample-app-myconnectwebhook-ruby
+cd sample-app-webhooks-ruby
 ```
 
 ### Create appsettings.yml file
@@ -73,11 +73,11 @@ config.hosts << "xxx-xx-xxx-xxx-xx.ngrok.io"
 ### Setup your custom Docusign Connect configuration
 
 #### Using a ruby script
-The ruby script included with this project sets up a custom Connect configuration with the same settings that the hosted app uses at https://myconnectwebhook.sampleapps.docusign.com. You'll need to provide a name for your new custom connect configuration as well as the URL to publish which, if running locally using ngrok, should follow the format `https://{YOUR_NGROK_HOST}.ngrok.io/api/docusign/trigger/do_process.json`.
+The ruby script included with this project sets up a custom Connect configuration with the same settings that the hosted app uses at https://webhooks.sampleapps.docusign.com. You'll need to provide a name for your new custom connect configuration as well as the URL to publish which, if running locally using ngrok, should follow the format `https://{YOUR_NGROK_HOST}.ngrok.io/api/docusign/trigger/do_process.json`.
 
 * Navigate to the root folder of the app
   ```
-  cd sample-app-myconnectwebhook-ruby
+  cd sample-app-webhooks-ruby
   ```
 * Run the ruby script `create_connect_configuration.rb`
   ```
@@ -196,7 +196,7 @@ Use NVM https://github.com/nvm-sh/nvm and Node.js version 16+.
 yarn install
 ```
 
-#### Running MyConnectWebhook Sample App
+#### Running the Webhooks Sample App
 ```
  bin/dev
 ```
diff --git a/app/javascript/src/components/Header.js b/app/javascript/src/components/Header.js
@@ -38,7 +38,7 @@ export function Header() {
               <li className="nav-item">
                 <a
                   className="nav-link"
-                  href="https://github.com/docusign/sample-app-myconnectwebhook-ruby"
+                  href="https://github.com/docusign/sample-app-webhooks-ruby"
                   target="_blank"
                   rel="noopener noreferrer"
                 >
diff --git a/app/views/layouts/application.html.erb b/app/views/layouts/application.html.erb
@@ -1,11 +1,11 @@
 <!DOCTYPE html>
 <html>
   <head>
-    <title>"MyConnectWebhook Docusign Sample Application"</title>
+    <title>"Webhooks Sample App"</title>
     <meta name="viewport" content="width=device-width,initial-scale=1">
-    <meta property="og:title" content="MyConnectWebhook Docusign Sample Application" />
+    <meta property="og:title" content="Webhooks Sample App" />
     <meta property="og:description" content="Discover how the Docusign Connect webhook service can help you monitor and automate your business processes through real-time updates when specific events are triggered in your workflows." />
-    <meta property="og:image" content="/images/MyConnectWebhook_OG.png" />
+    <meta property="og:image" content="/images/Webhooks-Sample-App-OG-Image.jpg" />
 
     <div class="  "></div>
     <%= render '/partials/track_analytics' %>
diff --git a/public/images/MyConnectWebhook_OG.png b/public/images/MyConnectWebhook_OG.png
diff --git a/public/images/Webhooks-Sample-App-OG-Image.jpg b/public/images/Webhooks-Sample-App-OG-Image.jpg
diff --git a/public/locales/en/AutomatedWorkflow.json b/public/locales/en/AutomatedWorkflow.json
@@ -9,7 +9,7 @@
   },
   "ApiDecription": {
     "SeeMore": "Behind the scenes",
-    "CodeFlow": "<h3>This sample features:</h3><ul><li>Create and activate an elastic template</li><li>Embed an elastic template on your site</li><li>Docusign Connect webhook service</li><li>Remote signing</li></ul><h3>Code flow:</h3><p>View source file <a target='_blank' rel='noopener noreferrer' href='https://github.com/docusign/sample-app-myconnectwebhook-ruby/blob/main/app/services/clickwraps/clickwrap_service.rb'>clickwrap_service.rb</a> on GitHub.</p><h5>Step 1</h5><p>Once recipient information is submitted by the user, the Click API is used to create a new elastic template if it doesn’t already exist in the account. To create an elastic template, we must provide a document for the user to read and agree to, a name for the elastic template, and we must define <code>display_settings</code> to control what the UI experience will look like. The elastic template is created using <a target='_blank' rel='noopener noreferrer' href='https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/createclickwrap/'>ClickWraps:createClickwrap</a>. Then we must activate the elastic template before use with <a target='_blank' rel='noopener noreferrer' href='https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/updateclickwrapversion/'>ClickWraps:updateClickwrapVersion</a> by updating the elastic template and setting the status to <code>active</code>.</p><h5>Step 2</h5><p>Using the ID of the elastic template created in the previous step, we display the elastic template using a JavaScript API call to the <code>docuSignClick.Clickwrap.render()</code> method. Required arguments include <code>clickwrap_environment</code>, which is <code>https://demo.docusign.net</code> for the development environment; <code>clickwrap_account_id</code>, which is the account ID for the preconfigured Docusign developer account; <code>clickwrap_id</code>, which we obtain in the previous step; and <code>client_user_id</code>, which is created in the app session. To make this client-side API call, the code needs to include https://demo.docusign.net/clickapi/sdk/latest/docusign-click.js on the page as a script element.</p><h5>Step 3</h5><p>View source file <a target='_blank' rel='noopener noreferrer' href='https://github.com/docusign/sample-app-myconnectwebhook-ruby/blob/main/app/controllers/api/docusign/trigger_controller.rb#L35'>trigger_controller.rb</a> on GitHub.</p><p>Once the user accepts or declines the elastic signing agreement, we wait for a Docusign Connect notification to tell us what action was taken. If we receive a <code>click-agreed</code> notification, we can start the next step of the example workflow, otherwise the workflow ends at this step. The screenshot below shows the events to which we subscribe in our custom Connect configuration in the preconfigured account.</p> <p><img width='600px' src='/images/click_connect_config.png' alt='click connect configuration' /></p><h5>Step 4</h5><p>View source code <a target='_blank' rel='noopener noreferrer' href='https://github.com/docusign/sample-app-myconnectwebhook-ruby/blob/main/app/services/e_sign/send_envelope_service.rb'>send_envelope_service.rb</a> on GitHub.</p> <p>After receiving the <code>click-agreed</code> notification, we use the Docusign eSignature REST API to create an envelope with <a target='_blank' rel='noopener noreferrer' href='https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/'>Envelopes:create</a>. In the envelope definition, we include a recipient with the information submitted by the user, a sample purchase confirmation document, and tabs. We set the envelope definition status to <code>sent</code> so that the envelope is sent immediately when we make our API call.</p>"
+    "CodeFlow": "<h3>This sample features:</h3><ul><li>Create and activate an elastic template</li><li>Embed an elastic template on your site</li><li>Docusign Connect webhook service</li><li>Remote signing</li></ul><h3>Code flow:</h3><p>View source file <a target='_blank' rel='noopener noreferrer' href='https://github.com/docusign/sample-app-webhooks-ruby/blob/main/app/services/clickwraps/clickwrap_service.rb'>clickwrap_service.rb</a> on GitHub.</p><h5>Step 1</h5><p>Once recipient information is submitted by the user, the Click API is used to create a new elastic template if it doesn’t already exist in the account. To create an elastic template, we must provide a document for the user to read and agree to, a name for the elastic template, and we must define <code>display_settings</code> to control what the UI experience will look like. The elastic template is created using <a target='_blank' rel='noopener noreferrer' href='https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/createclickwrap/'>ClickWraps:createClickwrap</a>. Then we must activate the elastic template before use with <a target='_blank' rel='noopener noreferrer' href='https://developers.docusign.com/docs/click-api/reference/accounts/clickwraps/updateclickwrapversion/'>ClickWraps:updateClickwrapVersion</a> by updating the elastic template and setting the status to <code>active</code>.</p><h5>Step 2</h5><p>Using the ID of the elastic template created in the previous step, we display the elastic template using a JavaScript API call to the <code>docuSignClick.Clickwrap.render()</code> method. Required arguments include <code>clickwrap_environment</code>, which is <code>https://demo.docusign.net</code> for the development environment; <code>clickwrap_account_id</code>, which is the account ID for the preconfigured Docusign developer account; <code>clickwrap_id</code>, which we obtain in the previous step; and <code>client_user_id</code>, which is created in the app session. To make this client-side API call, the code needs to include https://demo.docusign.net/clickapi/sdk/latest/docusign-click.js on the page as a script element.</p><h5>Step 3</h5><p>View source file <a target='_blank' rel='noopener noreferrer' href='https://github.com/docusign/sample-app-webhooks-ruby/blob/main/app/controllers/api/docusign/trigger_controller.rb#L35'>trigger_controller.rb</a> on GitHub.</p><p>Once the user accepts or declines the elastic signing agreement, we wait for a Docusign Connect notification to tell us what action was taken. If we receive a <code>click-agreed</code> notification, we can start the next step of the example workflow, otherwise the workflow ends at this step. The screenshot below shows the events to which we subscribe in our custom Connect configuration in the preconfigured account.</p> <p><img width='600px' src='/images/click_connect_config.png' alt='click connect configuration' /></p><h5>Step 4</h5><p>View source code <a target='_blank' rel='noopener noreferrer' href='https://github.com/docusign/sample-app-webhooks-ruby/blob/main/app/services/e_sign/send_envelope_service.rb'>send_envelope_service.rb</a> on GitHub.</p> <p>After receiving the <code>click-agreed</code> notification, we use the Docusign eSignature REST API to create an envelope with <a target='_blank' rel='noopener noreferrer' href='https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/'>Envelopes:create</a>. In the envelope definition, we include a recipient with the information submitted by the user, a sample purchase confirmation document, and tabs. We set the envelope definition status to <code>sent</code> so that the envelope is sent immediately when we make our API call.</p>"
   },
   "Error": {
     "FullNameIsRequired": "Full name is required",
diff --git a/public/locales/en/Common.json b/public/locales/en/Common.json
@@ -1,7 +1,7 @@
 ﻿{
-  "ApplicationName": "MyConnectWebhook",
+  "ApplicationName": "Webhooks Sample App",
   "GitHubLink": "GitHub Source",
-  "Copyright": "© 2024 Docusign Inc.",
+  "Copyright": "© 2025 Docusign Inc.",
   "LogOutLink": "Logout",
   "LogInButton": "Login",
   "AlertMessage": "Sorry, there was some issue with the Code Grant Authorization, so you have been logged with JWT authorization"
diff --git a/public/locales/en/Home.json b/public/locales/en/Home.json
@@ -1,5 +1,5 @@
 {
-  "Header1": "MyConnectWebhook",
+  "Header1": "Webhooks Sample App",
   "Header2": "Discover how the Docusign Connect webhook service can help you monitor and automate your business processes through real-time updates when specific events are triggered in your workflows.",
   "Footer1": "Docusign: It's time to agree better",
   "Footer2": "<p>Docusign helps organizations connect and automate how they prepare, sign, act on, and manage agreements.</p>",
diff --git a/public/locales/en/MonitorEnvelopeStatus.json b/public/locales/en/MonitorEnvelopeStatus.json

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ export function Header() {`
`38`	`38`	`<li className="nav-item">`
`39`	`39`	`<a`
`40`	`40`	`className="nav-link"`
`41`		`- href="https://github.com/docusign/sample-app-myconnectwebhook-ruby"`
	`41`	`+ href="https://github.com/docusign/sample-app-webhooks-ruby"`
`42`	`42`	`target="_blank"`
`43`	`43`	`rel="noopener noreferrer"`
`44`	`44`	`>`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "Header1": "MyConnectWebhook",`
	`2`	`+ "Header1": "Webhooks Sample App",`
`3`	`3`	`"Header2": "Discover how the Docusign Connect webhook service can help you monitor and automate your business processes through real-time updates when specific events are triggered in your workflows.",`
`4`	`4`	`"Footer1": "Docusign: It's time to agree better",`
`5`	`5`	`"Footer2": "<p>Docusign helps organizations connect and automate how they prepare, sign, act on, and manage agreements.</p>",`