Ravenhub API
Send Notification
POST https://api.ravenhub.io/company/:appId/subscribers/:subscriberId/events/:eventId
Sends event data to Ravenhub which will trigger a notification(s) to be sent to the subscriber identified in the path. The body of the request can include JSON data that can be used in notification templates.
Path Parameters
eventId
string
Event Type ID which can be found in the Event Type section of the Ravenhub admin app.
subscriberId
string
Unique ID for the user who should receive the notification
appId
string
Ravenhub app ID can be found in the top right corner of the Ravenhub admin app.
event created successfullyfailed to create event : <details>curl https://api.ravenhub.io/company/MK6ey8wi3b/subscribers/foo1/events/owtDEKN0iP \
-H 'Content-Type: application/json' \
-d '{ "priority" : "Critical" }'
const subscriberId = 'foo1';
let endpoint = 'https://api.ravenhub.io/company/MK6ey8wi3b/subscribers/'
+ subscriberId + '/events/owtDEKN0iP';
axios.post(endpoint, { "priority" : "Critical" }, {
headers: {'Content-type': 'application/json'}
});
Send Broadcast
POST https://api.ravenhub.io/company/:appId/broadcasts/:broadcastId
Sends broadcast notifications to the list of subscriber IDs specified in the body of the request. See example below for formatting. The body of the request can include JSON data that can be used in notification templates.
Path Parameters
appId
string
Ravenhub app ID can be found in the top right corner of the Ravenhub admin app.
broadcastId
string
Broadcast ID is automatically generated when you create a broadcast through the admin app. Find it on the broadcast page in the URL or in the API endpoint field when viewing the Broadcast page
event broadcast sent successfullyfailed to send broadcast : <details>curl https://api.ravenhub.io/company/MK6ey8wi3b/broadcasts/owtDEKN0iP \
-H 'Content-Type: application/json' \
-d '{"notifications":[{"subscriberId":"foo1"},{"subscriberId":"foo2"}]}'
var endpoint = 'https://api.ravenhub.io/company/MK6ey8wi3b/broadcasts/owtDEKN0iP';
/*
The "data" key is optional within each notification
object in the notifications array below.
*/
var postBody =
{
"notifications" : [
{
"subscriberId" : "foo1",
"data" : {
"val1" : "hello again",
"val2" : "hi",
"urlvar" : "https://google.com"
}
},
{
"subscriberId" : "foo2",
"data" : {
"val1" : "hello again",
"val2" : "hi",
"urlvar" : "https://yahoo.com"
}
}
]
}
axios.post(endpoint, postBody, {
headers: {'Content-type': 'application/json'}
});
Last updated
Was this helpful?