Hightouch Go SDK

Hightouch exposes a REST API that lets users interact with resources like syncs, models, sources and destinations.

SDK Installation

go get github.com/speakeasy-sdks/hightouch-go-sdk

Authentication

• Create an API key
• From the API keys tab on the Settings page, select Add API key.
• Enter a descriptive Name for your key.
• Copy your API key and store it in a safe location. The key will only be displayed once.
• Click Create API key.

SDK Example Usage

Example

package main

import (
	"context"
	hightouchgosdk "github.com/speakeasy-sdks/hightouch-go-sdk"
	"github.com/speakeasy-sdks/hightouch-go-sdk/pkg/models/shared"
	"log"
)

func main() {
	s := hightouchgosdk.New(
		hightouchgosdk.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
	)

	ctx := context.Background()
	res, err := s.CreateDestination(ctx, shared.DestinationCreate{
		Configuration: map[string]interface{}{
			"key": "<value>",
		},
		Name: "<value>",
		Slug: "<value>",
		Type: "<value>",
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.OneOf != nil {
		// handle response
	}
}

Available Resources and Operations

Hightouch SDK

• CreateDestination - Create Destination
• CreateModel - Create Model
• CreateSource - Create Source
• CreateSync - Create Sync
• GetDestination - Get Destination
• GetModel - Get Model
• GetSource - Get Source
• GetSync - Get Sync
• GetSyncSequenceRun - Sync sequence status
• ListDestination - List Destinations
• ListModel - List Models
• ListSource - List Sources
• ListSync - List Syncs
• ListSyncRuns - List Sync Runs
• TriggerRun - Trigger Sync
• TriggerRunCustom - Trigger Sync From ID or Slug
• TriggerRunIDGraph
• TriggerSequenceRun - Trigger Sync sequence
• UpdateDestination - Update Destination
• UpdateModel - Update Model
• UpdateSource - Update Source
• UpdateSync - Update Sync

Special Types

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.

Error Object	Status Code	Content Type
sdkerrors.ValidateErrorJSON	409,422	application/json
sdkerrors.SDKError	4xx-5xx	/

Example

package main

import (
	"context"
	"errors"
	hightouchgosdk "github.com/speakeasy-sdks/hightouch-go-sdk"
	"github.com/speakeasy-sdks/hightouch-go-sdk/pkg/models/sdkerrors"
	"github.com/speakeasy-sdks/hightouch-go-sdk/pkg/models/shared"
	"log"
)

func main() {
	s := hightouchgosdk.New(
		hightouchgosdk.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
	)

	ctx := context.Background()
	res, err := s.CreateDestination(ctx, shared.DestinationCreate{
		Configuration: map[string]interface{}{
			"key": "<value>",
		},
		Name: "<value>",
		Slug: "<value>",
		Type: "<value>",
	})
	if err != nil {

		var e *sdkerrors.ValidateErrorJSON
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *sdkerrors.SDKError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}
	}
}

Server Selection

Select Server by Index

You can override the default server globally using the WithServerIndex option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server	Variables
0	https://api.hightouch.com/api/v1	None

Example

package main

import (
	"context"
	hightouchgosdk "github.com/speakeasy-sdks/hightouch-go-sdk"
	"github.com/speakeasy-sdks/hightouch-go-sdk/pkg/models/shared"
	"log"
)

func main() {
	s := hightouchgosdk.New(
		hightouchgosdk.WithServerIndex(0),
		hightouchgosdk.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
	)

	ctx := context.Background()
	res, err := s.CreateDestination(ctx, shared.DestinationCreate{
		Configuration: map[string]interface{}{
			"key": "<value>",
		},
		Name: "<value>",
		Slug: "<value>",
		Type: "<value>",
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.OneOf != nil {
		// handle response
	}
}

Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL option when initializing the SDK client instance. For example:

package main

import (
	"context"
	hightouchgosdk "github.com/speakeasy-sdks/hightouch-go-sdk"
	"github.com/speakeasy-sdks/hightouch-go-sdk/pkg/models/shared"
	"log"
)

func main() {
	s := hightouchgosdk.New(
		hightouchgosdk.WithServerURL("https://api.hightouch.com/api/v1"),
		hightouchgosdk.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
	)

	ctx := context.Background()
	res, err := s.CreateDestination(ctx, shared.DestinationCreate{
		Configuration: map[string]interface{}{
			"key": "<value>",
		},
		Name: "<value>",
		Slug: "<value>",
		Type: "<value>",
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.OneOf != nil {
		// handle response
	}
}

Custom HTTP Client

The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.

import (
	"net/http"
	"time"
	"github.com/myorg/your-go-sdk"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = sdk.New(sdk.WithClient(httpClient))
)

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
BearerAuth	http	HTTP Bearer

You can configure it using the WithSecurity option when initializing the SDK client instance. For example:

package main

import (
	"context"
	hightouchgosdk "github.com/speakeasy-sdks/hightouch-go-sdk"
	"github.com/speakeasy-sdks/hightouch-go-sdk/pkg/models/shared"
	"log"
)

func main() {
	s := hightouchgosdk.New(
		hightouchgosdk.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
	)

	ctx := context.Background()
	res, err := s.CreateDestination(ctx, shared.DestinationCreate{
		Configuration: map[string]interface{}{
			"key": "<value>",
		},
		Name: "<value>",
		Slug: "<value>",
		Type: "<value>",
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.OneOf != nil {
		// handle response
	}
}

SDK Generated by Speakeasy