Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/novuhq/go-novu

GO SDK for Novu - The open-source notification infrastructure for engineers. 🚀
https://github.com/novuhq/go-novu

go golang hacktoberfest novu novu-api

Last synced: 6 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/novuhq/go-novu
Owner: novuhq
License: mit
Created: 2022-06-22T09:51:50.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2024-08-21T01:02:44.000Z (4 months ago)
Last Synced: 2024-12-17T11:32:51.127Z (6 days ago)
Topics: go, golang, hacktoberfest, novu, novu-api
Language: Go
Homepage:
Size: 125 KB
Stars: 58
Watchers: 7
Forks: 43
Open Issues: 32
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-novu - Go

README

        # Novu's API v1 Go Library

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

## Installation & Usage

Install the package to your GoLang project.

```golang

go get github.com/novuhq/go-novu

```

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```golang

package main

import (

	"context"

	"fmt"

	novu "github.com/novuhq/go-novu/lib"

	"log"

)

func main() {

	subscriberID := "<"

	apiKey := ""

	eventId := ""

	ctx := context.Background()

	to := map[string]interface{}{

		"lastName":     "Doe",

		"firstName":    "John",

		"subscriberId": subscriberID,

		"email":        "[email protected]",

	}

	payload := map[string]interface{}{

		"name": "Hello World",

		"organization": map[string]interface{}{

			"logo": "https://happycorp.com/logo.png",

		},

	}

	data := novu.ITriggerPayloadOptions{To: to, Payload: payload}

	novuClient := novu.NewAPIClient(apiKey, &novu.Config{})

	resp, err := novuClient.EventApi.Trigger(ctx, eventId, data)

	if err != nil {

		log.Fatal("novu error", err.Error())

		return

	}

	fmt.Println(resp)

	// get integrations

	integrations, err := novuClient.IntegrationsApi.GetAll(ctx)

	if err != nil {

		log.Fatal("Get all integrations error: ", err.Error())

	}

	fmt.Println(integrations)

}

```

**NOTE**

Check the `cmd` directory to see a sample implementation and test files to see sample tests

## Documentation for API Endpoints

Class | Method                                                                           | HTTP request                            | Description

------------ |----------------------------------------------------------------------------------|-----------------------------------------| -------------

*EventApi* | [**Trigger**](https://docs.novu.co/platform/subscribers#removing-a-subscriber)   | **Post** /events/trigger                | Trigger

*EventApi* | [**TriggerBulk**](https://docs.novu.co/api/trigger-event/)   | **Post** /v1/events/trigger/bulk               | Bulk trigger event

*EventApi* | [**BroadcastToAll**](https://docs.novu.co/api/broadcast-event-to-all/)   | **Post** /v1/events/trigger/broadcast               | Broadcast event to all

*EventApi* | [**CancelTrigger**](https://docs.novu.co/api/cancel-triggered-event/)   | **Delete** /v1/events/trigger/:transactionId                | Cancel triggered event

*SubscriberApi* | [**Get**](https://docs.novu.co/api/get-subscriber/) | **Get** /subscribers/:subscriberId                 | Get a subscriber

*SubscriberApi* | [**Identify**](https://docs.novu.co/platform/subscribers#creating-a-subscriber) | **Post** /subscribers                 | Create a subscriber

*SubscriberApi* | [**Update**](https://docs.novu.co/platform/subscribers#updating-subscriber-data)     | **Put** /subscribers/:subscriberID    | Update subscriber data

*SubscriberApi* | [**Delete**](https://docs.novu.co/platform/subscribers#removing-a-subscriber)     | **Delete** /subscribers/:subscriberID | Removing a subscriber

*SubscriberApi* | [**Get**](https://docs.novu.co/api/get-a-notification-feed-for-a-particular-subscriber)     | **Get** /subscribers/:subscriberId/notifications/feed | Get a notification feed for a particular subscriber

*SubscriberApi* | [**Get**](https://docs.novu.co/api/get-the-unseen-notification-count-for-subscribers-feed)     | **Get** /subscribers/:subscriberId/notifications/feed | Get the unseen notification count for subscribers feed

*SubscriberApi* | [**Post**](https://docs.novu.co/api/mark-a-subscriber-feed-message-as-seen)     | **Post** /v1/subscribers/:subscriberId/messages/markAs | Mark a subscriber feed message as seen

*SubscriberApi* | [**Get**](https://docs.novu.co/api/get-subscriber-preferences/)     | **Get** /subscribers/:subscriberId/preferences | Get subscriber preferences

*SubscriberApi* | [**Patch**](https://docs.novu.co/api/update-subscriber-preference/)     | **Patch** /subscribers/:subscriberId/preferences/:templateId | Update subscriber preference

*TopicsApi* | [**Get**](https://docs.novu.co/api/filter-topics/) | **Get** /topics | Get a list of topics

*TopicsApi* | [**Get**](https://docs.novu.co/api/get-topic/) | **Get** /topics/:topicKey | Get a topic by its topic key

*TopicsApi* | [**Post**](https://docs.novu.co/api/topic-creation/) | **Post** /topics | Create a topic

*TopicsApi* | [**Patch**](https://docs.novu.co/api/rename-a-topic/) | **Patch** /topics/:topicKey | Rename a topic

*TopicsApi* | [**Delete**](https://docs.novu.co/api/delete-topic/) | **Delete** /topics/:topicKey | Delete a topic

*TopicsApi* | [**Post**](https://docs.novu.co/api/subscribers-addition/) | **Post** /topics/:topicKey/subscribers | Add subscribers to a topic by key

*TopicsApi* | [**Post**](https://docs.novu.co/api/subscribers-removal/) | **Post** /topics/:topicKey/subscribers/removal |Remove subscribers from a topic

*IntegrationsApi* | [**Create**](https://docs.novu.co/platform/integrations)                         | **Post** /integrations                  | Create an integration

*IntegrationsApi* | [**Update**](https://docs.novu.co/platform/integrations)                         | **Put** /integrations/:integrationId    | Update an integration

*IntegrationsApi* | [**Delete**](https://docs.novu.co/platform/integrations)                         | **Delete** /integrations/:integrationId | Delete an integration

*IntegrationsApi* | [**Get**](https://docs.novu.co/platform/integrations)                            | **Get** /integrations                   | Get all integrations

*IntegrationsApi* | [**GetActive**](https://docs.novu.co/platform/integrations)                      | **Get** /integrations/active            | Get all active integrations

_InboundParserApi_ | [**Get**](https://docs.novu.co/platform/inbound-parse-webhook/) | **Get** /inbound-parse/mx/status | Validate the mx record setup for the inbound parse functionality

## Authorization (api-key)

- **Type**: API key

- **API key parameter name**: ApiKey

- **Location**: HTTP header

### For more information about these methods and their parameters, see the [API documentation](https://docs.novu.co/api-reference/overview).  

## Support and Feedback

Be sure to visit the Novu official [documentation website](https://docs.novu.co/docs) for additional information about our API.

If you find a bug, please post the issue on [Github](https://github.com/novuhq/go-novu/issues).

As always, if you need additional assistance, join our Discord us a note [here](https://discord.gg/novu).

## Contributors

Name |

------------ |

[Oyewole Samuel](https://github.com/samsoft00) |

[Dima Grossman](https://github.com/scopsy) |