README.md

go-zendesk

Zendesk API client library for Go

• Reference

Installation

$ go get github.com/nukosuke/go-zendesk

Usage

package main

import (
    "context"

    "github.com/nukosuke/go-zendesk/zendesk"
)

func main() {
    // You can set custom *http.Client here
    client, _ := zendesk.NewClient(nil)

    // example.zendesk.com
    client.SetSubdomain("example")

    // Authenticate with API token
    client.SetCredential(zendesk.NewAPITokenCredential("[email protected]", "apitoken"))

    // Authenticate with agent password
    client.SetCredential(zendesk.NewBasicAuthCredential("[email protected]", "password"))

    // Create resource
    client.CreateGroup(context.Background(), zendesk.Group{
        Name: "support team",
    })
}

Want to mock API?

go-zendesk has a mock package generated by uber-go/mock. You can simulate the response from Zendesk API with it.

To regenerate the mock client

go generate ./...

Zendesk OBP(Offset Based Pagination) to CBP(Cursor Based Pagination) migration guide

CBPMigration

Maintainer

• nukosuke

License

MIT License.

See the file LICENSE.