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

Name
Type
Description

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 successfully
curl https://api.ravenhub.io/company/MK6ey8wi3b/subscribers/foo1/events/owtDEKN0iP \
  -H 'Content-Type: application/json' \
  -d '{ "priority" : "Critical" }'

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

Name
Type
Description

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 successfully
curl https://api.ravenhub.io/company/MK6ey8wi3b/broadcasts/owtDEKN0iP \
  -H 'Content-Type: application/json' \
  -d '{"notifications":[{"subscriberId":"foo1"},{"subscriberId":"foo2"}]}'

Last updated