novu-go

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 9 Open GitHub ↗

GO SDK for Novu - The open-source notification infrastructure for engineers. 🚀

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<br/>

<h1 align="center">The &lt;Inbox /&gt; infrastructure for modern products</h1>

<div align="center">
The notification platform that turns complex multi-channel delivery into a single <Inbox /> component. Built for developers, designed for growth, powered by open source.
</div>

# Novu's API v2 Go SDK

Novu's API exposes the entire Novu features via a standardized programmatic interface. Please refer to the [full documentation](https://docs.novu.co/) to learn more.

Developer-friendly & type-safe Go SDK specifically catered to leverage Novu API.

## Summary

Novu API: Novu REST API. Please see https://docs.novu.co/api-reference for more details.

For more information about the API: [Novu Documentation](https://docs.novu.co)

## Table of Contents

* [Novu's API v2 Go SDK](#novus-api-v2-go-sdk)
  * [SDK Installation](#sdk-installation)
  * [SDK Example Usage](#sdk-example-usage)
  * [Authentication](#authentication)
  * [Available Resources and Operations](#available-resources-and-operations)
  * [Retries](#retries)
  * [Error Handling](#error-handling)
  * [Server Selection](#server-selection)
  * [Custom HTTP Client](#custom-http-client)
* [Development](#development)
  * [Contributions](#contributions)

## SDK Installation

To add the SDK as a dependency to your project:
```bash
go get github.com/novuhq/novu-go/v3
```

## SDK Example Usage

### Trigger Notification Event

```go
package main

import (
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/components"
	"log"
)

func main() {
	ctx := context.Background()

s := v3.New(
		v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
	)

res, err := s.Trigger(ctx, components.TriggerEventRequestDto{
		WorkflowID: "workflow_identifier",
		Payload: map[string]any{
			"comment_id": "string",
			"post": map[string]any{
				"text": "string",
			},
		},
		BridgeURL: v3.Pointer("https://your-tunnel.novu.co/api/novu"),
		Overrides: &components.Overrides{},
		AgentID:   v3.Pointer("support-agent"),
		To: components.CreateTriggerEventRequestDtoToStr(
			"SUBSCRIBER_ID",
		),
		Actor: v3.Pointer(components.CreateActorStr(
			"<value>",
		)),
		Context: map[string]components.TriggerEventRequestDtoContext{
			"key": components.CreateTriggerEventRequestDtoContextStr(
				"org-acme",
			),
		},
	}, nil)
	if err != nil {
		log.Fatal(err)
	}
	if res.TriggerEventResponseDto != nil {
		// handle response
	}
}

```

### Cancel Triggered Event

```go
package main

import (
	"context"
	"github.com/novuhq/novu-go/v3"
	"log"
)

func main() {
	ctx := context.Background()

s := v3.New(
		v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
	)

res, err := s.Cancel(ctx, "<id>", nil)
	if err != nil {
		log.Fatal(err)
	}
	if res.Boolean != nil {
		// handle response
	}
}

```

### Broadcast Event to All

```go
package main

import (
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/components"
	"log"
)

func main() {
	ctx := context.Background()

s := v3.New(
		v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
	)

res, err := s.TriggerBroadcast(ctx, components.TriggerEventToAllRequestDto{
		Name: "<value>",
		Payload: map[string]any{
			"comment_id": "string",
			"post": map[string]any{
				"text": "string",
			},
		},
		Overrides: &components.TriggerEventToAllRequestDtoOverrides{
			AdditionalProperties: map[string]map[string]any{
				"fcm": map[string]any{
					"data": map[string]any{
						"key": "value",
					},
				},
			},
		},
		AgentID: v3.Pointer("support-agent"),
		Actor: v3.Pointer(components.CreateTriggerEventToAllRequestDtoActorSubscriberPayloadDto(
			components.SubscriberPayloadDto{
				FirstName:    v3.Pointer("John"),
				LastName:     v3.Pointer("Doe"),
				Email:        v3.Pointer("john.doe@example.com"),
				Phone:        v3.Pointer("+1234567890"),
				Avatar:       v3.Pointer("https://example.com/avatar.jpg"),
				Locale:       v3.Pointer("en-US"),
				Timezone:     v3.Pointer("America/New_York"),
				SubscriberID: "<id>",
			},
		)),
		Context: map[string]components.TriggerEventToAllRequestDtoContext{
			"key": components.CreateTriggerEventToAllRequestDtoContextStr(
				"org-acme",
			),
		},
	}, nil)
	if err != nil {
		log.Fatal(err)
	}
	if res.TriggerEventResponseDto != nil {
		// handle response
	}
}

```

### Trigger Notification Events in Bulk

```go
package main

import (
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/components"
	"log"
)

func main() {
	ctx := context.Background()

s := v3.New(
		v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
	)

res, err := s.TriggerBulk(ctx, components.BulkTriggerEventDto{
		Events: []components.TriggerEventRequestDto{
			components.TriggerEventRequestDto{
				WorkflowID: "workflow_identifier",
				Payload: map[string]any{
					"comment_id": "string",
					"post": map[string]any{
						"text": "string",
					},
				},
				Overrides: &components.Overrides{},
				To: components.CreateTriggerEventRequestDtoToStr(
					"SUBSCRIBER_ID",
				),
			},
			components.TriggerEventRequestDto{
				WorkflowID: "workflow_identifier",
				Payload: map[string]any{
					"comment_id": "string",
					"post": map[string]any{
						"text": "string",
					},
				},
				Overrides: &components.Overrides{},
				To: components.CreateTriggerEventRequestDtoToStr(
					"SUBSCRIBER_ID",
				),
			},
			components.TriggerEventRequestDto{
				WorkflowID: "workflow_identifier",
				Payload: map[string]any{
					"comment_id": "string",
					"post": map[string]any{
						"text": "string",
					},
				},
				Overrides: &components.Overrides{},
				To: components.CreateTriggerEventRequestDtoToStr(
					"SUBSCRIBER_ID",
				),
			},
		},
	}, nil)
	if err != nil {
		log.Fatal(err)
	}
	if res.TriggerEventResponseDtos != nil {
		// handle response
	}
}

```

### Send an agent reply

```go
package main

import (
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/components"
	"log"
)

func main() {
	ctx := context.Background()

s := v3.New(
		v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
	)

res, err := s.Agents.SendReply(ctx, "support-agent", components.AgentReplyPayloadDto{
		ConversationID:        "64f5a1c2e8b7a3d9f0c1b2a3",
		IntegrationIdentifier: "slack-support",
		Reply: v3.Pointer(components.CreateReplyMarkdownReplyContentDto(
			components.MarkdownReplyContentDto{
				Markdown: "**Report ready.** Your weekly summary is attached.",
			},
		)),
	}, nil)
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

```

## Authentication

### Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name        | Type   | Scheme  | Environment Variable |
| ----------- | ------ | ------- | -------------------- |
| `SecretKey` | apiKey | API key | `NOVU_SECRET_KEY`    |

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

import (
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/components"
	"log"
)

func main() {
	ctx := context.Background()

s := v3.New(
		v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
	)

```

## Available Resources and Operations

<details open>
<summary>Available methods</summary>

### [Novu SDK](docs/sdks/novu/README.md)

* [Trigger](docs/sdks/novu/README.md#trigger) - Trigger event
* [Cancel](docs/sdks/novu/README.md#cancel) - Cancel triggered event
* [TriggerBroadcast](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
* [TriggerBulk](docs/sdks/novu/README.md#triggerbulk) - Bulk trigger event

### [Activity](docs/sdks/activity/README.md)

* [Track](docs/sdks/activity/README.md#track) - Track provider activity and engagement events

### [Agents](docs/sdks/agents/README.md)

* [Create](docs/sdks/agents/README.md#create) - Create an agent
* [List](docs/sdks/agents/README.md#list) - List all agents
* [SendReply](docs/sdks/agents/README.md#sendreply) - Send an agent reply
* [Retrieve](docs/sdks/agents/README.md#retrieve) - Retrieve an agent
* [Update](docs/sdks/agents/README.md#update) - Update an agent
* [Delete](docs/sdks/agents/README.md#delete) - Delete an agent
* [UpdateBridge](docs/sdks/agents/README.md#updatebridge) - Update an agent bridge

#### [Agents.Integrations](docs/sdks/novuintegrations/README.md)

* [Create](docs/sdks/novuintegrations/README.md#create) - Create an agent integration
* [List](docs/sdks/novuintegrations/README.md#list) - List agent integrations
* [Update](docs/sdks/novuintegrations/README.md#update) - Update an agent integration
* [Delete](docs/sdks/novuintegrations/README.md#delete) - Delete an agent integration

### [ChannelConnections](docs/sdks/channelconnections/README.md)

* [List](docs/sdks/channelconnections/README.md#list) - List all channel connections
* [Create](docs/sdks/channelconnections/README.md#create) - Create a channel connection
* [Retrieve](docs/sdks/channelconnections/README.md#retrieve) - Retrieve a channel connection
* [Update](docs/sdks/channelconnections/README.md#update) - Update a channel connection
* [Delete](docs/sdks/channelconnections/README.md#delete) - Delete a channel connection

### [ChannelEndpoints](docs/sdks/channelendpoints/README.md)

* [List](docs/sdks/channelendpoints/README.md#list) - List all channel endpoints
* [Create](docs/sdks/channelendpoints/README.md#create) - Create a channel endpoint
* [Retrieve](docs/sdks/channelendpoints/README.md#retrieve) - Retrieve a channel endpoint
* [Update](docs/sdks/channelendpoints/README.md#update) - Update a channel endpoint
* [Delete](docs/sdks/channelendpoints/README.md#delete) - Delete a channel endpoint

### [Contexts](docs/sdks/contexts/README.md)

* [Create](docs/sdks/contexts/README.md#create) - Create a context
* [List](docs/sdks/contexts/README.md#list) - List all contexts
* [Update](docs/sdks/contexts/README.md#update) - Update a context
* [Retrieve](docs/sdks/contexts/README.md#retrieve) - Retrieve a context
* [Delete](docs/sdks/contexts/README.md#delete) - Delete a context

### [Domains](docs/sdks/domains/README.md)

* [List](docs/sdks/domains/README.md#list) - List domains for an environment
* [Create](docs/sdks/domains/README.md#create) - Create a domain
* [Retrieve](docs/sdks/domains/README.md#retrieve) - Retrieve a domain by name
* [Update](docs/sdks/domains/README.md#update) - Update a domain
* [Delete](docs/sdks/domains/README.md#delete) - Delete a domain
* [Diagnose](docs/sdks/domains/README.md#diagnose) - Diagnose inbound DNS for a domain
* [Verify](docs/sdks/domains/README.md#verify) - Verify a domain

#### [Domains.AutoConfigure](docs/sdks/autoconfigure/README.md)

* [Retrieve](docs/sdks/autoconfigure/README.md#retrieve) - Retrieve auto-configuration availability
* [Start](docs/sdks/autoconfigure/README.md#start) - Start DNS auto-configuration

#### [Domains.Routes](docs/sdks/routes/README.md)

* [List](docs/sdks/routes/README.md#list) - List routes for a domain
* [Create](docs/sdks/routes/README.md#create) - Create a route
* [Retrieve](docs/sdks/routes/README.md#retrieve) - Retrieve a route by address
* [Update](docs/sdks/routes/README.md#update) - Update a route
* [Delete](docs/sdks/routes/README.md#delete) - Delete a route
* [Test](docs/sdks/routes/README.md#test) - Test an inbound route

### [EnvironmentVariables](docs/sdks/environmentvariables/README.md)

* [List](docs/sdks/environmentvariables/README.md#list) - List all variables
* [Create](docs/sdks/environmentvariables/README.md#create) - Create a variable
* [Retrieve](docs/sdks/environmentvariables/README.md#retrieve) - Get environment variable
* [Update](docs/sdks/environmentvariables/README.md#update) - Update a variable
* [Delete](docs/sdks/environmentvariables/README.md#delete) - Delete environment variable
* [Usage](docs/sdks/environmentvariables/README.md#usage) - Retrieve a variable usage

### [Environments](docs/sdks/environments/README.md)

* [GetTags](docs/sdks/environments/README.md#gettags) - List environment tags
* [Diff](docs/sdks/environments/README.md#diff) - Compare resources between environments
* [Publish](docs/sdks/environments/README.md#publish) - Publish resources to target environment
* [Create](docs/sdks/environments/README.md#create) - Create an environment
* [List](docs/sdks/environments/README.md#list) - List all environments
* [Update](docs/sdks/environments/README.md#update) - Update an environment
* [Delete](docs/sdks/environments/README.md#delete) - Delete an environment

### [Integrations](docs/sdks/integrations/README.md)

* [List](docs/sdks/integrations/README.md#list) - List all integrations
* [Create](docs/sdks/integrations/README.md#create) - Create an integration
* [Update](docs/sdks/integrations/README.md#update) - Update an integration
* [Delete](docs/sdks/integrations/README.md#delete) - Delete an integration
* [IntegrationsControllerAutoConfigureIntegration](docs/sdks/integrations/README.md#integrationscontrollerautoconfigureintegration) - Auto-configure an integration for inbound webhooks
* [SetAsPrimary](docs/sdks/integrations/README.md#setasprimary) - Update integration as primary
* [CreateMobileLink](docs/sdks/integrations/README.md#createmobilelink) - Issue a short-lived mobile setup link for an existing integration
* [IntegrationsControllerConfigureIntegrationWebhook](docs/sdks/integrations/README.md#integrationscontrollerconfigureintegrationwebhook) - Configure a chat integration webhook
* [ListActive](docs/sdks/integrations/README.md#listactive) - List active integrations
* [GenerateConnectOAuthURL](docs/sdks/integrations/README.md#generateconnectoauthurl) - Generate OAuth URL for a workspace/tenant connection
* [LinkChannelEndpoint](docs/sdks/integrations/README.md#linkchannelendpoint) - Issue a URL to link a subscriber chat identity
* [GenerateLinkUserOAuthURL](docs/sdks/integrations/README.md#generatelinkuseroauthurl) - Generate OAuth URL to link a subscriber user identity
* [~~GenerateChatOAuthURL~~](docs/sdks/integrations/README.md#generatechatoauthurl) - Generate chat OAuth URL :warning: **Deprecated**

### [Layouts](docs/sdks/layouts/README.md)

* [Create](docs/sdks/layouts/README.md#create) - Create a layout
* [List](docs/sdks/layouts/README.md#list) - List all layouts
* [Update](docs/sdks/layouts/README.md#update) - Update a layout
* [Retrieve](docs/sdks/layouts/README.md#retrieve) - Retrieve a layout
* [Delete](docs/sdks/layouts/README.md#delete) - Delete a layout
* [Duplicate](docs/sdks/layouts/README.md#duplicate) - Duplicate a layout
* [GeneratePreview](docs/sdks/layouts/README.md#generatepreview) - Generate layout preview
* [Usage](docs/sdks/layouts/README.md#usage) - Get layout usage

### [Messages](docs/sdks/messages/README.md)

* [Retrieve](docs/sdks/messages/README.md#retrieve) - List all messages
* [Delete](docs/sdks/messages/README.md#delete) - Delete a message
* [DeleteByTransactionID](docs/sdks/messages/README.md#deletebytransactionid) - Delete messages by transactionId

### [Notifications](docs/sdks/notifications/README.md)

* [List](docs/sdks/notifications/README.md#list) - List all events
* [Retrieve](docs/sdks/notifications/README.md#retrieve) - Retrieve an event

### [Subscribers](docs/sdks/subscribers/README.md)

* [Search](docs/sdks/subscribers/README.md#search) - Search subscribers
* [Create](docs/sdks/subscribers/README.md#create) - Create a subscriber
* [Retrieve](docs/sdks/subscribers/README.md#retrieve) - Retrieve a subscriber
* [Patch](docs/sdks/subscribers/README.md#patch) - Update a subscriber
* [Delete](docs/sdks/subscribers/README.md#delete) - Delete a subscriber
* [CreateBulk](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers

#### [Subscribers.Credentials](docs/sdks/credentials/README.md)

* [Update](docs/sdks/credentials/README.md#update) - Update provider credentials
* [Append](docs/sdks/credentials/README.md#append) - Upsert provider credentials
* [Delete](docs/sdks/credentials/README.md#delete) - Delete provider credentials

#### [~~Subscribers.Messages~~](docs/sdks/novumessages/README.md)

* [~~UpdateAsSeen~~](docs/sdks/novumessages/README.md#updateasseen) - Update notification action status :warning: **Deprecated**
* [~~MarkAll~~](docs/sdks/novumessages/README.md#markall) - Update all notifications state :warning: **Deprecated**
* [~~MarkAllAs~~](docs/sdks/novumessages/README.md#markallas) - Update notifications state :warning: **Deprecated**

#### [Subscribers.Notifications](docs/sdks/novunotifications/README.md)

* [List](docs/sdks/novunotifications/README.md#list) - Retrieve subscriber notifications
* [Delete](docs/sdks/novunotifications/README.md#delete) - Delete a notification
* [CompleteAction](docs/sdks/novunotifications/README.md#completeaction) - Complete a notification action
* [RevertAction](docs/sdks/novunotifications/README.md#revertaction) - Revert a notification action
* [Archive](docs/sdks/novunotifications/README.md#archive) - Archive a notification
* [MarkAsRead](docs/sdks/novunotifications/README.md#markasread) - Mark a notification as read
* [Snooze](docs/sdks/novunotifications/README.md#snooze) - Snooze a notification
* [Unarchive](docs/sdks/novunotifications/README.md#unarchive) - Unarchive a notification
* [MarkAsUnread](docs/sdks/novunotifications/README.md#markasunread) - Mark a notification as unread
* [Unsnooze](docs/sdks/novunotifications/README.md#unsnooze) - Unsnooze a notification
* [ArchiveAll](docs/sdks/novunotifications/README.md#archiveall) - Archive all notifications
* [Count](docs/sdks/novunotifications/README.md#count) - Retrieve subscriber notifications count
* [DeleteAll](docs/sdks/novunotifications/README.md#deleteall) - Delete all notifications
* [MarkAllAsRead](docs/sdks/novunotifications/README.md#markallasread) - Mark all notifications as read
* [ArchiveAllRead](docs/sdks/novunotifications/README.md#archiveallread) - Archive all read notifications
* [MarkAsSeen](docs/sdks/novunotifications/README.md#markasseen) - Mark notifications as seen
* [~~Feed~~](docs/sdks/novunotifications/README.md#feed) - Retrieve subscriber notifications :warning: **Deprecated**
* [~~UnseenCount~~](docs/sdks/novunotifications/README.md#unseencount) - Retrieve unseen notifications count :warning: **Deprecated**

#### [Subscribers.Preferences](docs/sdks/preferences/README.md)

* [List](docs/sdks/preferences/README.md#list) - Retrieve subscriber preferences
* [Update](docs/sdks/preferences/README.md#update) - Update subscriber preferences
* [BulkUpdate](docs/sdks/preferences/README.md#bulkupdate) - Bulk update subscriber preferences

#### [Subscribers.Properties](docs/sdks/properties/README.md)

* [UpdateOnlineFlag](docs/sdks/properties/README.md#updateonlineflag) - Update subscriber online status

#### [Subscribers.Topics](docs/sdks/novutopics/README.md)

* [List](docs/sdks/novutopics/README.md#list) - Retrieve subscriber subscriptions

### [Topics](docs/sdks/topics/README.md)

* [List](docs/sdks/topics/README.md#list) - List all topics
* [Create](docs/sdks/topics/README.md#create) - Create a topic
* [Get](docs/sdks/topics/README.md#get) - Retrieve a topic
* [Update](docs/sdks/topics/README.md#update) - Update a topic
* [Delete](docs/sdks/topics/README.md#delete) - Delete a topic

#### [Topics.Subscribers](docs/sdks/novusubscribers/README.md)

* [Retrieve](docs/sdks/novusubscribers/README.md#retrieve) - Check topic subscriber

#### [Topics.Subscriptions](docs/sdks/subscriptions/README.md)

* [List](docs/sdks/subscriptions/README.md#list) - List topic subscriptions
* [Create](docs/sdks/subscriptions/README.md#create) - Create topic subscriptions
* [Delete](docs/sdks/subscriptions/README.md#delete) - Delete topic subscriptions
* [GetSubscription](docs/sdks/subscriptions/README.md#getsubscription) - Retrieve a topic subscription
* [Update](docs/sdks/subscriptions/README.md#update) - Update a topic subscription

### [Translations](docs/sdks/translations/README.md)

* [Create](docs/sdks/translations/README.md#create) - Create a translation
* [Retrieve](docs/sdks/translations/README.md#retrieve) - Retrieve a translation
* [Delete](docs/sdks/translations/README.md#delete) - Delete a translation
* [Upload](docs/sdks/translations/README.md#upload) - Upload translation files

#### [Translations.Groups](docs/sdks/groups/README.md)

* [Delete](docs/sdks/groups/README.md#delete) - Delete a translation group
* [Retrieve](docs/sdks/groups/README.md#retrieve) - Retrieve a translation group

#### [Translations.Master](docs/sdks/master/README.md)

* [Retrieve](docs/sdks/master/README.md#retrieve) - Retrieve master translations JSON
* [Import](docs/sdks/master/README.md#import) - Import master translations JSON
* [Upload](docs/sdks/master/README.md#upload) - Upload master translations JSON file

### [Workflows](docs/sdks/workflows/README.md)

* [Create](docs/sdks/workflows/README.md#create) - Create a workflow
* [List](docs/sdks/workflows/README.md#list) - List all workflows
* [Update](docs/sdks/workflows/README.md#update) - Update a workflow
* [Get](docs/sdks/workflows/README.md#get) - Retrieve a workflow
* [Delete](docs/sdks/workflows/README.md#delete) - Delete a workflow
* [Patch](docs/sdks/workflows/README.md#patch) - Update a workflow
* [Sync](docs/sdks/workflows/README.md#sync) - Sync a workflow

#### [Workflows.Steps](docs/sdks/steps/README.md)

* [GeneratePreview](docs/sdks/steps/README.md#generatepreview) - Generate a step preview
* [Retrieve](docs/sdks/steps/README.md#retrieve) - Retrieve workflow step

</details>

## Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a `retry.Config` object to the call by using the `WithRetries` option:
```go
package main

import (
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/components"
	"github.com/novuhq/novu-go/v3/retry"
	"log"
	"models/operations"
)

func main() {
	ctx := context.Background()

s := v3.New(
		v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
	)

res, err := s.Trigger(ctx, components.TriggerEventRequestDto{
		WorkflowID: "workflow_identifier",
		Payload: map[string]any{
			"comment_id": "string",
			"post": map[string]any{
				"text": "string",
			},
		},
		BridgeURL: v3.Pointer("https://your-tunnel.novu.co/api/novu"),
		Overrides: &components.Overrides{},
		AgentID:   v3.Pointer("support-agent"),
		To: components.CreateTriggerEventRequestDtoToStr(
			"SUBSCRIBER_ID",
		),
		Actor: v3.Pointer(components.CreateActorStr(
			"<value>",
		)),
		Context: map[string]components.TriggerEventRequestDtoContext{
			"key": components.CreateTriggerEventRequestDtoContextStr(
				"org-acme",
			),
		},
	}, nil, operations.WithRetries(
		retry.Config{
			Strategy: "backoff",
			Backoff: &retry.BackoffStrategy{
				InitialInterval: 1,
				MaxInterval:     50,
				Exponent:        1.1,
				MaxElapsedTime:  100,
			},
			RetryConnectionErrors: false,
		}))
	if err != nil {
		log.Fatal(err)
	}
	if res.TriggerEventResponseDto != nil {
		// handle response
	}
}

```

If you'd like to override the default retry strategy for all operations that support retries, you can use the `WithRetryConfig` option at SDK initialization:
```go
package main

import (
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/components"
	"github.com/novuhq/novu-go/v3/retry"
	"log"
)

func main() {
	ctx := context.Background()

s := v3.New(
		v3.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
		v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
	)

```

## 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.

By Default, an API error will return `apierrors.APIError`. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation.

For example, the `Trigger` function may return the following errors:

| Error Type                              | Status Code                       | Content Type     |
| --------------------------------------- | --------------------------------- | ---------------- |
| apierrors.PayloadValidationExceptionDto | 400                               | application/json |
| apierrors.ErrorDto                      | 414                               | application/json |
| apierrors.ErrorDto                      | 401, 403, 404, 405, 409, 413, 415 | application/json |
| apierrors.ValidationErrorDto            | 422                               | application/json |
| apierrors.ErrorDto                      | 500                               | application/json |
| apierrors.APIError                      | 4XX, 5XX                          | \*/\*            |

### Example

```go
package main

import (
	"context"
	"errors"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/apierrors"
	"github.com/novuhq/novu-go/v3/models/components"
	"log"
)

func main() {
	ctx := context.Background()

s := v3.New(
		v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
	)

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

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

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

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

var e *apierrors.APIError
		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(serverIndex int)` 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                   | Description |
| --- | ------------------------ | ----------- |
| 0   | `https://api.novu.co`    |             |
| 1   | `https://eu.api.novu.co` |             |

#### Example

```go
package main

import (
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/components"
	"log"
)

func main() {
	ctx := context.Background()

s := v3.New(
		v3.WithServerIndex(0),
		v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
	)

```

### Override Server URL Per-Client

The default server can also be overridden globally using the `WithServerURL(serverURL string)` option when initializing the SDK client instance. For example:
```go
package main

import (
	"context"
	"github.com/novuhq/novu-go/v3"
	"github.com/novuhq/novu-go/v3/models/components"
	"log"
)

func main() {
	ctx := context.Background()

s := v3.New(
		v3.WithServerURL("https://eu.api.novu.co"),
		v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
	)

```

## 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:

```go
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.

```go
import (
	"net/http"
	"time"

"github.com/novuhq/novu-go/v3"
)

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

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

# Development

## Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. 
We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=github-com/novuhq/novu-go&utm_campaign=go)

novu-go

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README