drip

README

go-drip

Drip API wrapper for golang

Features

• Create a subscriber by email address
• Track an event
• Custom fields for subscribers and events
• Tagging/untagging subscribers
• Custom field key normalization

Not yet implemented:

• Other API endpoints

Examples

dripClient = drip.NewClient("DRIP_API_TOKEN", "DRIP_ACCOUNT_ID")
_ = dripClient.CreateSubscriber("an@email-adress.com", map[string]interface{}{ "first_name": "Chris" })
_ = dripClient.RecordEvent("an@email-address.com", "Registered")
_ = dripClient.TagSubscriber("an@email-address.com", "Beta")

Key normailzation

go-drip will normalize custom fields keys by removing $ characters, replacing spaces with underscores, and lower casing the entire key. For example:

"First Name" => "first_name"
"$email" => "email"

Drip will not add any custom fields even if only one key is malformed. This feature tries to guard you against that and helps avoid re-implementing the same transformations. I'm happy to accept or add additional transformations, if you'd benefit from them.

Documentation

Index

• func NormalizeKey(key string) string
• func NormalizedFields(customFields map[string]interface{}) map[string]interface{}
• type Client
  • func NewClient(apiKey, appID string) *Client
  • func (c Client) BatchUpdateSubscribers(subscribers []Subscriber) error
  • func (c Client) CreateSubscriber(email string, customFields map[string]interface{}) error
  • func (c Client) RecordEvent(email, eventName string) error
  • func (c Client) TagSubscriber(email, tag string) error
  • func (c Client) UntagSubscriber(email, tagName string) error
  • func (c Client) UpdateSubscriberEmail(email, newEmail string) error
• type Subscriber
  • func NewSubscriber(email string) Subscriber
  • func (s *Subscriber) AddCustomField(key, value string)

Functions

func NormalizeKey

func NormalizeKey(key string) string

func NormalizedFields

func NormalizedFields(customFields map[string]interface{}) map[string]interface{}

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client represents a Drip API client wrapper

func NewClient

func NewClient(apiKey, appID string) *Client

NewClient returns a client instance ready to act with Drip for the given app and API key

func (Client) BatchUpdateSubscribers

func (c Client) BatchUpdateSubscribers(subscribers []Subscriber) error

func (Client) CreateSubscriber

func (c Client) CreateSubscriber(email string, customFields map[string]interface{}) error

CreateSubscriber creates a new or updates an existing subscriber by email

func (Client) RecordEvent

func (c Client) RecordEvent(email, eventName string) error

RecordEvent sends a custom event to Drip

func (Client) TagSubscriber

func (c Client) TagSubscriber(email, tag string) error

TagSubscriber adds a tag to a subscriber

func (Client) UntagSubscriber

func (c Client) UntagSubscriber(email, tagName string) error

UntagSubscriber removes a tag from the subscriber email address

func (Client) UpdateSubscriberEmail

func (c Client) UpdateSubscriberEmail(email, newEmail string) error

UpdateSubscriberEmail updates an existing subscriber's email address. If an existing subscriber doesn't exist, a new subscriber is created with the newEmail value.

type Subscriber

type Subscriber struct {
	Email        string                 `json:"email"`
	CustomFields map[string]interface{} `json:"custom_fields,omitempty"`
	Tags         []string               `json:"tags,omitempty"`
	// contains filtered or unexported fields
}

func NewSubscriber

func NewSubscriber(email string) Subscriber

func (*Subscriber) AddCustomField

func (s *Subscriber) AddCustomField(key, value string)