Go SDK

Setup & Initialization

1. Install Package:

go get github.com/notificationapi-com/notificationapi-go-server-sdk

2. Import:

import (
  notificationapi "github.com/notificationapi-com/notificationapi-go-server-sdk"
)

3. Initialize:

notificationapi.Init("CLIENT_ID", "CLIENT_SECRET", "base_url")

* required

Region specific example:

use NotificationAPI\NotificationAPI;

notificationapi = NotificationAPI.new("CLIENT_ID", "CLIENT_SECRET", "https://api.eu.notificationapi.com");

Send

Used to send a notification to the specified user.

Pass content directly without templates

You can ignore the templates and pass the content directly through the API by specifying channel content objects on the request.

parameters := make(map[string]interface{})

notificationapi.Send(
    notificationapi.SendRequest{
        Type: "order_tracking",
        To: notificationapi.User{
          Id:    "spongebob.squarepants",
          Email: "spongebob@squarepants.com",
          Number: "+15005550006",
        },
        Email: map[string]interface{}{
          "subject": "Your Krabby Patty Order is Ready!",
          "html": "<h1>Order Update</h1><p>Your order is ready for pickup!</p>",
          "senderName": "Krusty Krab",
          "senderEmail": "orders@krustykrab.com",
        },
        SMS: map[string]interface{}{
          "message": "Your Krabby Patty order is ready for pickup!",
        },
        InApp: map[string]interface{}{"title": title, "image": image, "url": url},
        WebPush: map[string]interface{}{
          "title": "Order Update",
          "message": "Your Krabby Patty order is ready for pickup!",
          "icon": "https://example.com/icon.png", "url": "https://example.com"},
        MobilePush: map[string]interface{}{
          "title": "Order Update",
          "message": "Your Krabby Patty order is ready for pickup!"},
        Slack: map[string]interface{}{
          "text": "Your Krabby Patty order is ready for pickup!"
        },
    },
)

With templates and parameters

Use templates you designed in the Dashboard and inject dynamic values with parameters. The server renders your templates per-channel using the values you provide.

This example will send notifications over the channels and templates specified in our dashboard:

parameters := make(map[string]interface{}) // Change to map[string]interface{}
parameters["item"] = "Krabby Patty Burger"
parameters["address"] = "124 Conch Street"
parameters["orderId"] = "1234567890"

notificationapi.Send(
  notificationapi.SendRequest{
    Type: "order_tracking",
    To: notificationapi.User{
      Id:     "test_user_id",
      Email:  "spongebob@squarepants.com",
    },
    Parameters: parameters,
  },
)

Parameters

The send() method accepts an object with the following fields:

Options Object

Size Limitation

When using parameters (merge tags) in the body of your notifications, it is recommended that the size of the combined parameters not exceed 150 KB. Exceeding this limit may result in delivery failure, or an API error.

identifyUser

Stores the end-user information for a given user.

By using this function, you can omit the contact information when using send(). NotificationAPI will automatically lookup the user’s stored email or phone number and use it for sending the notification.

number := "+15005550006"
user := NotificationAPI.User{
		Id:     "spongebob.squarepants",
		Email:  "spongebob@squarepants.com",
		Number: &number,
		WebPushTokens: &[]NotificationAPI.UserWebPushToken{
			{
				Sub: struct {
					Endpoint string `json:"endpoint,omitempty"`
					Keys     struct {
						P256DH string `json:"p256dh,omitempty"`
						Auth   string `json:"auth,omitempty"`
					} `json:"keys,omitempty"`
				}{
					Endpoint: "https://fcm.googleapis.com/fcm/send/fCs_4iba0Ao:APA91bGFdaU7I3****JMH_KeZwk1Xi",
					Keys: struct {
						P256DH string `json:"p256dh,omitempty"`
						Auth   string `json:"auth,omitempty"`
					}{
						P256DH: "zP2xFu3hMc2vNH5E2nuKkyjpZydvCk9llRUY2kP4****9aSlKcoadSV2UbvMRQ",
						Auth:   "CXEFun************tYe8g",
					},
				},
			},
		},
	}
var params notificationapi.SetUserPreferencesRequest
NotificationAPI.IdentifyUser(user)

Parameters

pushTokens object

device object

webPushTokens object

Web push subscription (sub) object

Web push subscription keys object

setUserPreferences

Used to set a user’s notification preferences. This function will override the user’s existing preferences.

jsonParams := `[
  {
    type: "new_order",
    channel: "INAPP_WEB",
    delivery: "weekly"
  },
  {
    type: "order_tracking",
    channel: "SMS",
    delivery: "weekly"
  }
]`
var params notificationapi.SetUserPreferencesRequest
json.Unmarshal([]byte(jsonParams), &params)
notificationapi.SetUserPreferences("userId", params)

Parameters

Preference Object

deleteUserPreferences

Used to delete any stored preferences for a user and type or subNotificationId.

jsonParams := `{
  Type: "order_tracking",
  UserId: "spongebob.squarepants"
}`
var params notificationapi.DeleteUserPreferencesRequest
json.Unmarshal([]byte(jsonParams), &params)
notificationapi.DeleteUserPreferences(params);

Parameters

updateInAppNotification

Used to update the opened, archived, … of an inapp notification.

notificationapi.UpdateInAppNotification("spongebob.squarepants", map[string]interface{}{
	"trackingIds": []string{"sampleTrackingId"},
	"opened":      "1970-01-01T00:00:00.000Z",
	"clicked":     "1970-01-01T00:00:00.000Z",
	"archived":    "1970-01-01T00:00:00.000Z",
	"actioned1":   "1970-01-01T00:00:00.000Z",
	"actioned2":   "1970-01-01T00:00:00.000Z",
	"reply": map[string]interface{}{
		"date":    "1970-01-01T00:00:00.000Z",
		"message": "nice!",
	},
})

Parameters

params

retract

Only applicable to in-app notifications. This function helps you delete all notifications of a certain type for a user.

jsonParams := `{
  Type: "order_tracking",
  UserId: "spongebob.squarepants"
}`
var params notificationapi.RetractRequest
json.Unmarshal([]byte(jsonParams), &params)
notificationapi.Retract(params);

updateSchedule

This function enables you to update a scheduled notification by providing a trackingId.

updateReq := NotificationAPI.UpdateScheduleRequest{
		Schedule: "2024-02-20T14:38:03.509Z",
	}
trackingId := "172cf2f4-18cd-4f1f-b2ac-e50c7d71891c"
notificationapi.UpdateSchedule(trackingId, updateReq)

deleteSchedule

This function allows you to delete a scheduled notification by providing a trackingId.

 trackingId := "172cf2f4-18cd-4f1f-b2ac-e50c7d71891c"
 notificationapi.DeleteSchedule(trackingId)

queryLogs

This function allows you to run queries on the logs of your send requests.

params := map[string]interface{}{
  // [startTime, endTime] unix timestamps (ms)
  "dateRangeFilter": []int64{1719600830559, 1719600840559},
  "notificationFilter": []string{"order_tracking"},
  "channelFilter":      []string{"EMAIL"},
  "userFilter":         []string{"abcd-1234"},
  "statusFilter":       []string{"SUCCESS"},
  "trackingIds":        []string{"172cf2f4-18cd-4f1f-b2ac-e50c7d71891c"},
  "requestFilter":      []string{`request.parameters.item="Krabby Patty Burger"`},
  "envIdFilter":        []string{"6ok6imq9unr2budgiebjdaa6oi"},
}

notificationAPI.QueryLogs(params)