ellsclytn / up-settle

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Up Settle

A Lambda function to automatically create Settle Up expenses when criteria are met

Requirements

Usage

The application uses Lambda & API Gateway. For the function to run, you'll need to configure the following environment variables in the Lambda config:

  • SETTLE_UP_USERNAME: Your Settle Up username
  • SETTLE_UP_PASSWORD: Your Settle Up password
  • SETTLE_UP_GROUP: The name of the Settle Up group to target
  • SETTLE_UP_USER: The name of the Settle Up user to create expenses under
  • SETTLE_UP_AUTH_CONFIG: JSON Object with Firebase configuration properties
  • API_TOKEN: Up Personal Access Token

Once deployed, you'll need to generate a Webhook on the Up API. The easiest way of doing this is to simply use your preferred HTTP client and follow the documentation. You'll need to note the secretKey returned on Webhook creation.

After the webhook is created, a new deployment of the Lambda function is required, this time with an additional environment variable:

  • WEBHOOK_KEY: The secretKey value mentioned above.

About

License:MIT License


Languages

Language:TypeScript 98.8%Language:JavaScript 1.2%