A tool to automatically sync Square customers to listmonk
Report Bugs
·
Request Features
To host listmonk-sync, you'll need an API key from Square and your listmonk credentials.
The easiest way to host listmonk-sync is via Docker.
First, clone this repo and cd into the directory.
git clone https://github.com/Insprill/listmonk-sync
cd listmonk-sync
Next, open the docker-compose.yml, find SQUARE_API_TOKEN: "token" and replace token with the token with your Square access token.
Then, set LISTMONK_USER and LISTMONK_PASSWORD the same way.
To finish the setup, open the config.json file and fill in the provided parameters. For more information, checkout the configuration section.
Finally, you can start the container.
docker compose up -d
| Key | Description | Default |
|---|---|---|
run_every |
How often sync's should run. A sync will run when the program is started, then every n seconds. | 3600 |
listmonk_domain |
The domain of your listmonk instance. Shouldn't include the scheme or a subdirectory. | example.com |
listmonk_list_ids |
The IDs of the lists to add the imported customers to. You can find the ID at the top of the edit panel. | 1,2,3 |
listmonk_confirmation |
Whether the imported customers should be marked as confirmed. | true |
listmonk_overwrite |
Whether subscribers already in listmonk should be overwritten. | false |
To compile BuildTools Assistant, you'll need Rust.
Clone this repo, then run cargo build --release from your terminal.
You can find the compiled program in the target/release directory.
Contributions are what make the open source community such an amazing place to learn, inspire, and create.
While this project was made for my own needs, if you find it useful and would like to contribute, that'd be greatly appreciated!
If you're new to contributing to open-source projects, you can follow this guide.
Distributed under the Apache 2.0 License. See LICENSE for more information.