˟
Transactional API
Prerequisites
Function
The Transactional API allows an external application to trigger a push notification for an individual subscriber.
Endpoint
POST https://api.pushnami.com/api/push/v2/transactional/{campaign}
Requirements
| Parameter | Required? | Description | Sample |
|---|---|---|---|
headers.authorization |
required | API Token | eyJ2... |
params.campaign |
required | Pushnami Campaign Id (string) |
"596fcc42565b5d1104fb8e08" |
payload.psid |
optional | Pushnami Subscriber Id to send notification to (string) - required if payload.csid is not set |
"596fcc42565b5d1104fb8e09" |
payload.csid |
optional | Alternative Subscriber Id to send notification to (string) - required if payload.psid is not set |
"ID_20148" |
payload.title |
required | Notification Title (string) |
"Sample Notification Title" |
payload.message |
required | Notification Message (string) |
"Sample Notification Message" |
payload.link |
required | Notification Link (string) |
"https://pushnami.com" |
payload.icon |
optional | Notification Icon Url (string) |
"https://pushnami.com/sample-image.png" |
Sample Request
curl -X POST \
https://api.pushnami.com/api/push/v2/transactional/596fce98cfe11a13409f1... \
-H 'authorization: eyJhbGciOiJIUzI....' \
-H 'cache-control: no-cache' \
-H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
-F psid=596f7aa60e7570462.... \
-F 'title=Sample Notification Title' \
-F 'message=Sample Notification Message' \
-F link=https://pushnami.com \
-F icon=https://pushnami.com/sample-image.png