https://github.com/docusign/connect-node-worker-aws
Connect listener example for AWS: a Node.js worker app
https://github.com/docusign/connect-node-worker-aws
Last synced: about 1 month ago
JSON representation
Connect listener example for AWS: a Node.js worker app
- Host: GitHub
- URL: https://github.com/docusign/connect-node-worker-aws
- Owner: docusign
- License: mit
- Created: 2019-06-12T15:26:44.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-23T22:59:55.000Z (about 3 years ago)
- Last Synced: 2024-05-17T16:52:25.126Z (almost 2 years ago)
- Language: JavaScript
- Homepage:
- Size: 251 KB
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Connect Node Worker for AWS
This is an example worker application for
Connect webhook notification messages sent
via the
[AWS SQS (Simple Queueing System)](https://aws.amazon.com/sqs/).
This application receives DocuSign Connect
messages from the queue and then processes them:
1. If the envelope is complete, the application
uses a DocuSign JWT Grant token to retrieve
the envelope's combined set of documents,
and stores them in the `output` directory.
For this example, the envelope **must**
include an Envelope Custom Field
named `Sales order.` The Sales order field is used
to name the output file.
1. Optionally, this worker app can be configured to
also change the color of an
[LIFX](https://www.lifx.com/)
bulb (or set of bulbs)
to the color set in the envelope's
Custom Field `Light color`
## Architecture
This figure shows the solution's architecture.
This worker application is written in Node.js.
But it
could be written in a different language.
AWS has
[SQS](https://aws.amazon.com/tools/)
SDK libraries for C#, Java, Node.js, Python, Ruby, C++, and Go.
## Installation
1. Install the example
[Connect listener for AWS](https://github.com/docusign/connect-node-listener-aws)
on AWS.
At the end of this step, you will have the
`Queue URL`, and `Queue Region`.
1. Using AWS IAM, create an IAM `User` with
access to your SQS queue.
Record the IAM user's AWS Access Key and Secret.
Configure environment variables
`AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` with the
IAM user credentials.
1. Install the latest Long Term Support version of
Node v8.x or v10.x on your system, with the
npm package manager.
1. Configure a DocuSign Integration Key for the application.
The application uses the OAuth JWT Grant flow.
If consent has not been granted to the application by
the user, then the application provides a url
that can be used to grant individual consent.
**To enable individual consent:** either
add the URL `https://www.docusign.com` as a redirect URI
for the Integration Key, or add a different URL and
update the `oAuthConsentRedirectURI` setting
in the ds_configuration.js file.
1. Download this repo to a directory.
1. In the directory:
`npm install`
1. Configure `ds_configuration.js` or set the
environment variables as indicated in that file.
1. Start the listener:
`npm start`
## Testing
Configure a DocuSign Connect subscription to send notifications to
the Cloud Function. Create / complete a DocuSign envelope.
The envelope **must include an Envelope Custom Field named "Sales order".**
* Check the Connect logs for feedback.
* Check the console output of this app for log output.
* Check the `output` directory to see if the envelope's
combined documents and CoC were downloaded.
For this code example, the
envelope's documents will only be downloaded if
the envelope is `complete` and includes a
`Sales order` custom field.
## Integration testing
This repository includes a `runTest.js` file. It conducts an
end-to-end integration test of enqueuing and dequeuing
test messages. See the file for more information.
## License and Pull Requests
### License
This repository uses the MIT License. See the LICENSE file for more information.
### Pull Requests
Pull requests are welcomed. Pull requests will only be considered if their content
uses the MIT License.