The integration Framework for Wickr allows developers to create event driven archtiectures representing serverless "bots" that can be used to construct Wickr integrations such as chat bots, workflows and any other process using many AWS services.

The reference architecture presented here is designed to give you a head start based on example use cases which can be extended for your organisations requirements.

The framwork is written using the AWS Serverless Application Model allowing developers to use common IDEs and local debugging.

The possiblities for creating AWS and Wickr integrations are endless but here are some example use cases:

In this use case a workflow could be created based on numerous decision points utilising customer data to drive the process.

The Wickr API can be exposed to other platforms internally and externally using the API Gateway. Other features include enhanced authorisation using Cognito.

Using an event based architecture opens up numerous AWS services

The framework has been written with developers in mind and it uses the AWS SAM which allows local development/debugging of Lambda functions.

• Install the latest SAM framework (this repo was built with v1.46.0+) - Install Guide
• Install AWS CLI V2
• You have configured the Wickr Web Interface API bot and have a Wickr API key, token and URL. - Wickr Rest API guide

make deploy/guided

Wickr API Token

The framework uses AWS Systems Manager Parameters to store the Wickr API access token which is used in the AWS Lambda Layer.

Given you are in a command line session with adequate AWS credentials run the following:

aws ssm put-parameter \
--name "/AWIF/ApiToken" \
--value <token> \
--type "SecureString" \
--overwrite

NOTE: The default throughput is 40 transactions per second for SSM Parameters. If you need to increase this limit you can folllow the steps here: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-throughput.html#parameter-store-throughput-increasing-cli

• AWS Serverless Application Model Developers guide

See CONTRIBUTING for more information.

This library is licensed under the MIT-0 License. See the LICENSE file.