lucid_intercom
Installation
Add the gem to your ‘Gemfile’:
gem 'lucid_intercom'
Usage
Configure the default API credentials
LucidIntercom.configure(
access_token: '...',
admin_id: 123456,
app_id: '...',
app_prefix: '...',
secret: '...',
)
Here, ‘app_prefix’ is the snakecased app name, e.g. ‘smart_order_tags’.
Alternatively load the configuration from a Ruby file. The Ruby file is evaluated and should return a hash.
LucidIntercom.configure_from_file('config/intercom.rb') # the default path
When loading from a file, any environment variables matching the upcased key with the prefix ‘INTERCOM_’ will override values in the file. For example ‘INTERCOM_APP_ID=...’.
Render the browser snippet
LucidIntercom::RenderSnippet.new.(shopify_data, app_data)
This returns an HTML string which you can use in your view layout.
See the source code for documentation of arguments.
Send an event
When a user installs/uninstalls the app, or changes their plan:
notify = LucidIntercom::NotifyInstalled.new
notify.(shopify_data, new_plan)
notify = LucidIntercom::NotifyUninstalled.new
notify.(shopify_data)
notify = LucidIntercom::NotifyChangedPlan.new
notify.(shopify_data, new_plan)
Note that the shopify_data hash for uninstalled events cannot be
read from the API (as the access token is invalid at this stage).
You should use the data hash provided with Shopify’s ‘app/uninstalled’
webhook instead.
Plan names
For installed apps, yet to subscribe to a plan, use ‘pending’.
For apps with a single paid plan, use ‘subscribed’.
For free apps, use ‘free’.
For partner-friendly app installs, use ‘partner’.
Custom events
To define a custom event, subclass LucidIntercom::Event. See the
source code for documentation, and existing subclasses:
LucidIntercom::NotifyChangedPlanLucidIntercom::NotifyInstalledLucidIntercom::NotifyUninstalled