Trigger an Event

POST

event

Trigger an Event

curl --request POST \
  --url https://hub.suprsend.com/event/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "distinct_id": "0fxxx8f74-xxxx-41c5-8752-xxxcb6911fb08",
  "event": "ON SHIPMENT ARRIVAL",
  "properties": {
    "amount": "3780$",
    "number": "TRXC1034",
    "vehicle": "Truck",
    "locations": "San Francisco"
  }
}
'

"OK"

Authorizations

Authorization

string

header

required

Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.

Body

application/json

distinct_id

string

default:_distinct_id_

required

distinct_id of recipient who should receive the notification

event

string

default:_event_name_

required

string identifier for the event like product_purchased

properties

object

Properties are used to render template or workflow variables in the trigger.

Show child attributes

properties.$attachments

(publicly accessible URL · object | base64-encoded file · object)[]

Use this key to pass email attachment in the trigger. You can either pass attachment as a public URL or as a base64-encoded file (limit < 50KB).

Option 1: Pass file as publicly accessible URL (No limit on file size)

publicly accessible URL
base64-encoded file

Show child attributes

properties.$attachments.url

string<uri>

required

Publicly accessible URL of the file

Example:

"https://bitcoincore.org/bitcoin.pdf"

properties.$attachments.filename

string

Filename to be shown in email

Example:

"billing.pdf"

properties.$attachments.ignore_if_error

boolean

Ignore the attachment if it fails to load

properties.{key}

string

tenant_id

string

string identifier of the tenant this event is associated with

$idempotency_key

string

Idempotency key (valid for 24hours)

Response

202 - application/json

202 - Accepted

message

string

Example:

"OK"

Create / Update ObjectsAPI to upsert (create if not exists, update if exists) object by providing a unique object ID and type.

⌘I

Trigger an Event

curl --request POST \
  --url https://hub.suprsend.com/event/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "distinct_id": "0fxxx8f74-xxxx-41c5-8752-xxxcb6911fb08",
  "event": "ON SHIPMENT ARRIVAL",
  "properties": {
    "amount": "3780$",
    "number": "TRXC1034",
    "vehicle": "Truck",
    "locations": "San Francisco"
  }
}
'

"OK"

API Reference

USERS

TRIGGER WORKFLOWS

EVENTS

OBJECTS

TEMPLATES

TENANTS

PREFERENCE

LISTS

BROADCAST

Authorizations

Body

Response