Send and Track Events

Send and track custom events from Go backends using the SuprSend Go SDK to trigger workflows, with method signatures, examples, and event property payloads.

Pre-Requisites

Create User Profile

Send Event

You can send event to Suprsend platform by using the suprClient.TrackEvent method. When you call suprClient.TrackEvent, the SDK internally makes an HTTP call to SuprSend Platform to register this request, and you’ll immediately receive a response indicating the acceptance status. The actual processing/execution of event happens asynchronously.

Request

ev := &suprsend.Event{
  EventName:  "__event_name__",
  DistinctId: "_distinct_id_",
  Properties: map[string]interface{}{
    "k1": "v1",
  },
  IdempotencyKey: "_unique_request_id_",
}

// Send event to Suprsend by calling .TrackEvent
_, err = suprClient.TrackEvent(ev)
if err != nil {
  log.Fatalln(err)
}

Parameter	Description	Type	Obligation
DistinctId	distinct_id of user performing the event	string	mandatory
EventName	string identifier for the event like product_purchased	string	mandatory
Properties	a dictionary representing event attributes like first_name Event properties can be used to pass template variables in case of event based trigger	Dictionary	optional
IdempotencyKey	idempotency_key is the unique identifier for an event, and expires in 24 hours.	string	optional

Event naming guidelines:

Event Name or Property Name should not start with $ or ss_, as we have reserved these symbols for our internal events and property names.

Idempotent requests

SuprSend supports idempotency to ensure that requests can be retried safely without duplicate processing. If Suprsend receives and processes a request with an idempotency_key, it will skip processing requests with same idempotency_key for next 24 hours. You can use this key to track webhooks related to workflow notifications.

Idempotency key should be unique that you generate for each request. You may use any string up to 255 characters in length. Any space at start and end of the key will be trimmed.

Here are some common approaches for assigning idempotency keys:

• Generate a random UUID for each request.
• Construct the idempotency key by combining relevant information about the request. This can include parameters, identifiers, or specific contextual details that are meaningful within your application. for example, you could concatenate the user ID, action, and timestamp to form an idempotency key like user147-new-comment-1687437670
• Request-specific Identifier: If your request already contains a unique identifier, such as an order ID or a job ID, you can use that identifier directly as the idempotency key.

Add file attachment in event (for email)

To add one or more Attachments to a Notification (viz. Email), you can just append the filepath of attachment to the event instance.

• Call event.AddAttachment() for each file, with a public URL or a local file path.
• Local files are base64-encoded into the request, so the total event size (including attachments) must stay within the 800 KB limit.

Request

ev := &suprsend.Event{
  EventName:  "invoice_generated",
  DistinctId: "0fxxx8f74-xxxx-41c5-8752-xxxcb6911fb08",
  Properties: map[string]interface{}{...},
}

// Add attachment (If needed) by calling .AddAttachment
err = ev.AddAttachment("https://www.adobe.com/sample_file.pdf", &suprsend.AttachmentOption{})
if err != nil {
  log.Println(err)
}

// Send event to Suprsend by calling .TrackEvent
_, err = suprClient.TrackEvent(ev)
if err != nil {
  log.Fatalln(err)
}

If you attach a URL, it must be publicly accessible, otherwise it will throw an error 404 not found and workflow will not be triggered

Bulk API for multiple event requests

You can use Bulk API to send multiple events. Use .Append() on bulk_events instance to add however-many-records to call in bulk.

Request

ev1 := &suprsend.Event{
  EventName:  "__event_name1__",
  DistinctId: "__distinct_id1__",
  Properties: map[string]interface{}{
    "k1": "v1",
  },
}

ev2 := &suprsend.Event{
  EventName:  "__event_name2__",
  DistinctId: "__distinct_id2__",
}

// Create bulkEvents instance
bulkIns := suprClient.BulkEvents.NewInstance()

// Add all events to bulk Instance
bulkIns.Append(ev1, ev2)

// call trigger to send all these events to SuprSend
bulkResponse, err := bulkIns.Trigger()
if err != nil {
  log.Fatalln(err)
}
log.Println(bulkResponse)

---