0.0
The project is in a healthy, maintained state
A lightweight, Faraday-based Ruby client for Blueshift CRM covering campaigns, events, customers, segments, adapters, and custom user lists.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

~> 3.0

Runtime

>= 2.9, < 3.0
 Project Readme

Blueshift CRM (Ruby)

A lightweight Ruby client for the Blueshift CRM API.

Install

bundle add blueshift_crm

Add ENV variables for API keys:

export BLUESHIFT_SITE_ID=""
export BLUESHIFT_EVENT_API_KEY=""
export BLUESHIFT_USER_API_KEY=""
export BLUESHIFT_API_PASSWORD=""

Optional:

export BLUESHIFT_REGION=""

Usage:

# create a client instance:
client = BlueshiftCRM::Client.new

Adapters:

client.adapters.list

Campaigns:

client.campaigns.list

Custom User Lists:

client.custom_user_lists.seed_lists

Customers:

client.customers.get(uuid: "")

Events:

client.events.history(event: "")

Segments:

client.segments.list