incident.io Go SDK

The official Go SDK for the incident.io public API.

It is generated automatically from our published OpenAPI schema, so it always tracks the live API — there is a method for every endpoint, and a Go type for every request and response.

Install

go get github.com/incident-io/sdk-go

Requires Go 1.24 or later.

Quickstart

Create an API key in your incident.io dashboard under Settings → API keys, then:

package main

import (
	"context"
	"fmt"
	"log"

	incident "github.com/incident-io/sdk-go"
)

func main() {
	c, err := incident.New("my-api-key")
	if err != nil {
		log.Fatal(err)
	}

	resp, err := c.IncidentsV2ListWithResponse(context.Background(), nil)
	if err != nil {
		log.Fatal(err)
	}
	if resp.JSON200 == nil {
		log.Fatalf("unexpected status %d: %s", resp.StatusCode(), resp.Body)
	}

	for _, inc := range resp.JSON200.Incidents {
		fmt.Printf("%s %s\n", inc.Reference, inc.Name)
	}
}

Every endpoint has a ...WithResponse method that returns a typed response. Inspect resp.StatusCode() and the resp.JSONxxx fields (e.g. JSON200, JSON404) to handle results — a nil JSON200 means the API returned a non-2xx status, and resp.Body holds the raw payload.

Configuration

New takes functional options:

c, err := incident.New("my-api-key",
	incident.WithUserAgent("my-app/1.0.0"),           // identify your integration
	incident.WithRetries(),                           // opt in to automatic retries
	incident.WithBaseURL("https://api.incident.io"),  // override the base URL
	incident.WithHTTPClient(myHTTPClient),            // bring your own HTTP client
)

Retries

By default the client makes a single attempt per request and does not retry. Pass WithRetries() to enable exponential backoff on transient failures (network errors, 429s and 5xxs); it honours the Retry-After header. Pass WithRetries(n) to cap the number of retries (default 4).

WithRetries works by installing a retrying HTTP client, so passing it alongside your own WithHTTPClient is redundant — the later option wins.

Deprecated endpoints

Endpoints that incident.io has deprecated (for example the v1 incidents and custom fields endpoints, superseded by v2) remain available but are marked with // Deprecated: — your editor and staticcheck will flag any calls to them so you can migrate to the current version.

Versioning

Releases are cut automatically whenever the API schema changes. We use SemVer: each automatic release bumps the minor version, and patch versions are reserved for hand-cut fixes. Before releasing, the schema is compared with the previous one using oasdiff. A change that would break Go consumers stops the release and opens an issue, and is never released automatically. It needs a deliberate major version, which for a Go module means moving the module path to /v2.

Support

Found a bug or missing something? Please open an issue. For questions about the API itself, see the API docs.

Note that incident.gen.go is generated — please don't send PRs editing it directly; changes there come from the upstream schema.

License

MIT — see LICENSE.

This SDK's generated code is produced by oapi-codegen, which is licensed under Apache-2.0.