{"id":25553843,"url":"https://github.com/docusign/connect-node-worker-aws","last_synced_at":"2026-02-18T23:30:17.280Z","repository":{"id":42346397,"uuid":"191597469","full_name":"docusign/connect-node-worker-aws","owner":"docusign","description":"Connect listener example for AWS: a Node.js worker app","archived":false,"fork":false,"pushed_at":"2023-01-23T22:59:55.000Z","size":257,"stargazers_count":1,"open_issues_count":6,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-17T16:52:25.126Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/docusign.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-06-12T15:26:44.000Z","updated_at":"2022-09-25T17:36:01.000Z","dependencies_parsed_at":"2023-01-25T11:30:35.108Z","dependency_job_id":null,"html_url":"https://github.com/docusign/connect-node-worker-aws","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docusign%2Fconnect-node-worker-aws","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docusign%2Fconnect-node-worker-aws/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docusign%2Fconnect-node-worker-aws/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docusign%2Fconnect-node-worker-aws/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/docusign","download_url":"https://codeload.github.com/docusign/connect-node-worker-aws/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239833540,"owners_count":19704628,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-20T12:02:07.223Z","updated_at":"2026-02-18T23:30:17.179Z","avatar_url":"https://github.com/docusign.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Connect Node Worker for AWS\n\nThis is an example worker application for\nConnect webhook notification messages sent\nvia the \n[AWS SQS (Simple Queueing System)](https://aws.amazon.com/sqs/).\n\nThis application receives DocuSign Connect\nmessages from the queue and then processes them:\n\n1. If the envelope is complete, the application\n   uses a DocuSign JWT Grant token to retrieve\n   the envelope's combined set of documents,\n   and stores them in the `output` directory.\n\n   For this example, the envelope **must** \n   include an Envelope Custom Field\n   named `Sales order.` The Sales order field is used\n   to name the output file.\n1. Optionally, this worker app can be configured to\n   also change the color of an \n   [LIFX](https://www.lifx.com/)\n   bulb (or set of bulbs)\n   to the color set in the envelope's \n   Custom Field `Light color`\n\n## Architecture\n![Connect listener architecture](docs/connect_listener_architecture.png)\n\nThis figure shows the solution's architecture. \nThis worker application is written in Node.js. \nBut it \ncould be written in a different language.\n\nAWS has\n[SQS](https://aws.amazon.com/tools/)\nSDK libraries for C#, Java, Node.js, Python, Ruby, C++, and Go. \n\n## Installation\n\n1. Install the example \n   [Connect listener for AWS](https://github.com/docusign/connect-node-listener-aws)\n   on AWS.\n   At the end of this step, you will have the\n   `Queue URL`, and `Queue Region`.\n\n1. Using AWS IAM, create an IAM `User` with \n   access to your SQS queue. \n\n   Record the IAM user's AWS Access Key and Secret.\n\n   Configure environment variables \n   `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` with the\n   IAM user credentials.\n\n1. Install the latest Long Term Support version of \n   Node v8.x or v10.x on your system, with the\n   npm package manager.\n\n1. Configure a DocuSign Integration Key for the application.\n   The application uses the OAuth JWT Grant flow.\n\n   If consent has not been granted to the application by\n   the user, then the application provides a url\n   that can be used to grant individual consent.\n\n   **To enable individual consent:** either\n   add the URL `https://www.docusign.com` as a redirect URI\n   for the Integration Key, or add a different URL and\n   update the `oAuthConsentRedirectURI` setting\n   in the ds_configuration.js file.\n\n1. Download this repo to a directory.\n\n1. In the directory:\n\n   `npm install`\n1. Configure `ds_configuration.js` or set the \n   environment variables as indicated in that file.\n\n1. Start the listener:\n\n   `npm start`\n\n## Testing\nConfigure a DocuSign Connect subscription to send notifications to\nthe Cloud Function. Create / complete a DocuSign envelope.\nThe envelope **must include an Envelope Custom Field named \"Sales order\".**\n\n* Check the Connect logs for feedback.\n* Check the console output of this app for log output.\n* Check the `output` directory to see if the envelope's\n  combined documents and CoC were downloaded.\n\n  For this code example, the \n  envelope's documents will only be downloaded if\n  the envelope is `complete` and includes a \n  `Sales order` custom field.\n\n## Integration testing\nThis repository includes a `runTest.js` file. It conducts an\nend-to-end integration test of enqueuing and dequeuing\ntest messages. See the file for more information.\n\n## License and Pull Requests\n\n### License\nThis repository uses the MIT License. See the LICENSE file for more information.\n\n### Pull Requests\nPull requests are welcomed. Pull requests will only be considered if their content\nuses the MIT License.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocusign%2Fconnect-node-worker-aws","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocusign%2Fconnect-node-worker-aws","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocusign%2Fconnect-node-worker-aws/lists"}