HubSpot Go Library that works with HubSpot API v3.
HubSpot officially supports client library of Node.js, PHP, Ruby, and Python but not Go.
Note: go-hubspot currently doesn't cover all the APIs but mainly implemented CRM APIs. Implemented APIs are used in production.
$ go get github.com/belong-inc/go-hubspot
Deprecated
You should take api key in advance. Follow steps in here.
// Initialize hubspot client with apikey.
client, _ := hubspot.NewClient(hubspot.SetAPIKey("YOUR_API_KEY"))
You should take refresh token in advance. Follow steps in here.
// Initialize hubspot client with OAuth refresh token.
client, _ := hubspot.NewClient(hubspot.SetOAuth(&hubspot.OAuthConfig{
GrantType: hubspot.GrantTypeRefreshToken,
ClientID: "YOUR_CLIENT_ID",
ClientSecret: "YOUR_CLIENT_SECRET",
RefreshToken: "YOUR_REFRESH_TOKEN",
}))
You should take access token in advance. Follow steps in here.
// Initialize hubspot client with private app access token.
client, _ := hubspot.NewClient(hubspot.SetPrivateAppToken("YOUR_ACCESS_TOKEN"))
// Initialize hubspot client with auth method.
client, _ := hubspot.NewClient(hubspot.SetPrivateAppToken("YOUR_ACCESS_TOKEN"))
// Get a Contact object whose id is `yourContactID`.
// Contact instance needs to be provided to bind response value.
res, _ := client.CRM.Contact.Get("yourContactID", &hubspot.Contact{}, nil)
// Type assertion to convert `interface` to `hubspot.Contact`.
contact, ok := res.Properties.(*hubspot.Contact)
if !ok {
return errors.New("unable to assert type")
}
// Use contact fields.
fmt.Println(contact.FirstName, contact.LastName)
// Initialize hubspot client with auth method.
client, _ := hubspot.NewClient(hubspot.SetPrivateAppToken("YOUR_ACCESS_TOKEN"))
// Create request payload.
req := &hubspot.Contact{
Email: hubspot.NewString("yourEmail"),
FirstName: hubspot.NewString("yourFirstName"),
LastName: hubspot.NewString("yourLastName"),
MobilePhone: hubspot.NewString("yourMobilePhone"),
Website: hubspot.NewString("yourWebsite"),
Zip: nil,
}
// Call create contact api.
res, _ := client.CRM.Contact.Create(req)
// Type assertion to convert `interface` to `hubspot.Contact`.
contact, ok := res.Properties.(*hubspot.Contact)
if !ok {
return errors.New("unable to assert type")
}
// Use contact fields.
fmt.Println(contact.FirstName, contact.LastName)
// Initialize hubspot client with auth method.
client, _ := hubspot.NewClient(hubspot.SetPrivateAppToken("YOUR_ACCESS_TOKEN"))
// Call associate api.
client.CRM.Contact.AssociateAnotherObj("yourContactID", &hubspot.AssociationConfig{
ToObject: hubspot.ObjectTypeDeal,
ToObjectID: "yourDealID",
Type: hubspot.AssociationTypeContactToDeal,
})
Custom fields are added out of existing object such as Deal or Contact.
Therefore a new struct needs to be created which contain default fields and additional custom field, and set to Properties field of a request.
Before using custom field through API, the field needs to be set up in HubSpot web site.
type CustomDeal struct {
hubspot.Deal // embed default fields.
CustomA string `json:"custom_a,omitempty"`
CustomB string `json:"custom_b,omitempty"`
}
// Initialize hubspot client with auth method.
client, _ := hubspot.NewClient(hubspot.SetPrivateAppToken("YOUR_ACCESS_TOKEN"))
// Get a Deal object whose id is `yourDealID`.
// CustomDeal instance needs to be provided as to bind response value contained custom fields.
res, _ := client.CRM.Deal.Get("yourDealID", &CustomDeal{}, &hubspot.RequestQueryOption{
CustomProperties: []string{
"custom_a",
"custom_b",
},
})
// Type assertion to convert `interface` to `CustomDeal`.
customDeal, ok := res.Properties.(*CustomDeal)
if !ok {
return errors.New("unable to assert type")
}
// Use custom deal fields.
fmt.Println(customDeal.CustomA, customDeal.CustomB)
type CustomDeal struct {
hubspot.Deal // embed default fields.
CustomA string `json:"custom_a,omitempty"`
CustomB string `json:"custom_b,omitempty"`
}
// Initialize hubspot client with auth method.
client, _ := hubspot.NewClient(hubspot.SetPrivateAppToken("YOUR_ACCESS_TOKEN"))
req := &CustomDeal{
Deal: hubspot.Deal{
Amount: hubspot.NewString("yourAmount"),
DealName: hubspot.NewString("yourDealName"),
DealStage: hubspot.NewString("yourDealStage"),
DealOwnerID: hubspot.NewString("yourDealOwnerID"),
PipeLine: hubspot.NewString("yourPipeLine"),
},
CustomA: "yourCustomFieldA",
CustomB: "yourCustomFieldB",
}
// Call create deal api with custom struct.
res, _ := client.CRM.Deal.Create(req)
// Type assertion to convert `interface` to `CustomDeal`.
customDeal, ok := res.Properties.(*CustomDeal)
if !ok {
return errors.New("unable to type assertion")
}
// Use custom deal fields.
fmt.Println(customDeal.CustomA, customDeal.CustomB)
Category | API | Availability |
---|---|---|
CRM | Deal | Available |
CRM | Company | Available |
CRM | Contact | Available |
CRM | Imports | Beta |
CRM | Schemas | Beta |
CRM | Properties | Beta |
CRM | Tickets | Beta |
CMS | All | Not Implemented |
Conversations | Visitor Identification | Available |
Events | All | Not Implemented |
Marketing | Marketing Email | Available |
Marketing | Transactional Email | Available |
Files | All | Not Implemented |
Settings | All | Not Implemented |
Webhooks | All | Not Implemented |
Type | Availability |
---|---|
API key | Deprecated |
OAuth | Available |
Private apps | Available |
Contributions are generally welcome.
Please refer to CONTRIBUTING.md when making your contribution.