​
Send Event

You can send event to Suprsend platform by using the supr_client.track_event method. When you call supr_client.track_event, 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. 
const { Suprsend, Event } = require("@suprsend/node-sdk");

const supr_client = new Suprsend("_workspace_key_", "_workspace_secret_");

// dictionary containing variable/info about event, If none use {}
const properties = {
  "key1":"value1",
  "key2":"value2"
}

const event = new Event(distinct_id, event_name, properties, {tenant_id : "_tenant_id", idempotency_key="__uniq_request_id__"})

// trigger request
const response  = supr_client.track_event(event)
response.then((res) => console.log("response", res));
ParameterDescription
distinct_iddistinct_id of subscriber performing the event.
event_namestring identifier for the event like product_purchased. This should exactly match the one from created workflow.
propertiesdictionary representing event information. This can be used to pass variables to template. Property keys shouldn’t start with ss_ or $.
tenant_id (Optional)Tenant ID of the tenant.
idempotency_key (Optional)unique key in the request call for idempotent requests.
Event naming guidelines:Event Name or Property Name should not start with or , 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. To make an idempotent request, pass idempotency_key in the event instance. idempotency_key should be unique that you generate for each request. You may use any string up to 255 characters in length as an idempotency key. Ensure that you don’t add any space in start and end of the key as it 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. e.g., 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.

​
Trigger multiple events in bulk

Use .append() on bulk_events instance to add however-many-records to call in bulk. 
const { Suprsend, Event } = require("@suprsend/node-sdk");

const supr_client = new Suprsend("_workspace_key_", "_workspace_secret_");

// create bulk instance
const bulk_ins = supr_client.bulk_events.new_instance();

// create event1 instance
const event1 = new Event("distinct_id1", "event_name1", {"k1": "v1"})
// create event2 instance
const event2 = new Event("distinct_id2", "event_name2", {"k2": "v2"})

// add event instance to bulk instance
bulk_ins.append(event1);
bulk_ins.append(event2);
// OR
bulk_ins.append(event1, event2);

// trigger request
const response = bulk_ins.trigger();
response.then((res) => console.log("response", res));

​
Add file attachment (for email)

To add one or more attachments to a notification (viz. Email), call add_attachment() on event instance for each attachment file. Ensure that attachment url is valid and public, otherwise error will be raised. Since event API size can’t be > 100 KB, local file paths can’t be passed in event attachment. 
const event = new Event(distinct_id, event_name, properties);

event.add_attachment("/home/user/billing.pdf");
event.add_attachment("https://www.adobe.com/sample_file.pdf");
A single event instance size (including attachment) must not exceed 100KB (100 x 1024 bytes).