A Ruby toolkit for the Drip API.
Add this line to your application's Gemfile:
gem 'drip-ruby', require: 'drip'
And then execute:
$ bundle
Or install it yourself as:
$ gem install drip-ruby
For private integrations, you may use your personal API Token (found
here) via the api_key setting:
client = Drip::Client.new do |c|
c.api_key = "YOUR_API_KEY"
c.account_id = "YOUR_ACCOUNT_ID"
endFor public integrations, pass in the user's OAuth token via the access_token
setting:
client = Drip::Client.new do |c|
c.access_token = "YOUR_ACCESS_TOKEN"
c.account_id = "YOUR_ACCOUNT_ID"
endYou may also pass client options in an argument hash:
client = Drip::Client.new(
access_token: "YOUR_ACCESS_TOKEN"
account_id: "YOUR_ACCOUNT_ID"
)Your account ID can be found here. Most API actions require an account ID, with the exception of methods like the "list accounts" endpoint.
Since the Drip client is a flat API client, most API actions are available as methods on the client object. The following methods are currently available:
| Actions | Methods |
|---|---|
| List accounts | #accounts |
| Fetch an account | #account(id) |
| Actions | Methods |
|---|---|
| List broadcasts | #broadcasts |
| Fetch a broadcast | #broadcast(id) |
| Actions | Methods |
|---|---|
| List campaigns | #campaigns(options = {}) |
| Fetch a campaign | #campaign(id) |
| Activate a campaign | #activate_campaign(id) |
| Pause a campaign | #pause_campaign(id) |
| List campaign subscribers | #campaign_subscribers(id) |
| Subscribe to a campaign | See the #subscribe method on "Subscribers" below |
| Actions | Methods |
|---|---|
| List subscriber subscriptions | #campaign_subscriptions(subscriber_id) |
| Actions | Methods |
|---|---|
| List all conversions | #conversions(options = {}) |
| Fetch a conversion | #conversion(id) |
| Actions | Methods |
|---|---|
| List all custom fields | #custom_fields |
| Actions | Methods |
|---|---|
| Track an event | #track_event(email, action, properties = {}) |
| Track a batch of events | #track_events(events) |
| List all custom event actions | #event_actions |
| Actions | Methods |
|---|---|
| List all forms | #forms |
| Fetch a form | #form(id) |
| Actions | Methods |
|---|---|
| Create or update an order | #create_or_update_order(email, options = {}) |
| Create or update a batch of orders | #create_or_update_orders(orders = {}) |
| Create or update a refund | #create_or_update_refund(options = {}) |
| Actions | Methods |
|---|---|
| List subscribers | #subscribers(options = {}) |
| Create/update a subscriber | #create_or_update_subscriber(email, options = {}) |
| Create/update a batch of subscribers | #create_or_update_subscribers(subscribers) |
| Unsubscribe a batch of subscribers | #unsubscribe_subscribers(subscribers) |
| Fetch a subscriber | #subscriber(id_or_email) |
| Delete | #delete_subscriber(id_or_email) |
| Subscribe to a campaign | #subscribe(email, campaign_id, options = {}) |
| Unsubscribe from all mailings | #unsubscribe_from_all(id_or_email) |
| Unsubscribe | #unsubscribe(id_or_email, options = {}) |
| Actions | Methods |
|---|---|
| List tags | #tags |
| Apply a tag | #apply_tag(email, tag) |
| Remove a tag | #remove_tag(email, tag) |
| Actions | Methods |
|---|---|
| Fetch user | #user |
| Actions | Methods |
|---|---|
| List webhooks | #webhooks |
| Fetch a webhook | #webhook(id) |
| Create a new webhook | #create_webhook(post_url, include_received_email, events) |
| Delete a webhook | #delete_webhook(id) |
| Actions | Methods |
|---|---|
| List workflows | #workflows |
| Fetch a workflow | #workflow(id) |
| Activate a workflow | #activate_workflow(id) |
| Pause a workflow | #pause_workflow(id) |
| Start a subscriber on a workflow | #start_subscriber_workflow(id, options = {}) |
| Remove a subscriber from a workflow | #remove_subscriber_workflow(workflow_id, id_or_email) |
| Actions | Methods |
|---|---|
| List workflow triggers | #workflow_triggers(id) |
| Create a workflow trigger | #create_workflow_trigger(id, options = {}) |
| Update a workflow trigger | #update_workflow_trigger(id, options = {} |
See the official REST API docs for a complete API reference and explanations.
Here are some common use cases for the API client.
Once you have an access token for a Drip user, you can fetch their accounts.
Initialize your client and pull down the user's accounts. To make further calls, set the account_id on your client to the account you want to access.
client = Drip::Client.new do |c|
c.access_token = "YOUR_ACCESS_TOKEN"
end
resp = client.accounts
# => <Drip::Response ...>
account_id = resp.accounts.first.id
# => "9999999"
client.account_id = account_idSubscribers can be looked up by their email address or by their Drip subscriber ID. Most of the time you will want to look up subscribers by their email address, unless you've already stored this ID in your database.
resp = client.subscriber("foo@example.com")
# => <Drip::Response ...>
resp.success?
# => true
subscriber = resp.subscribers.first
subscriber.email
# => "foo@example.com"- Fork it ( https://github.com/DripEmail/drip-ruby/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request