NAV

mPulse Alert API

The mPulse Alert API allows you to trigger and clear alerts from an external application. Although you can send your customized content at any time, there are rate limits.

The mPulse Alert API requires configuring an alert in the UI for external invocation. For details, see How to Configure Webhook for an Alert. For information, see How to Configure Webhook for an Alert.

Trigger an Alert

URL

POST https://mpulse.soasta.com/concerto/mpulse/api/alerts/<uid>/fire

Body

None or '{"message":"your message", "subject":"your subject"}'

Response

If the trigger is successful, the response will be 204 (No Content).

Examples

Send default content (no POST data)

curl -X POST https://mpulse.soasta.com/concerto/mpulse/api/alerts/<uid>/fire

Send customized content

Note that the subject parameter is only available for e-mail.

curl -X POST -H "Content-type: application/json" --data-binary '{"message":"PageView Count popped above upper-bound." , "subject":"Alert: Popped"}' https://mpulse.soasta.com/concerto/mpulse/api/alerts/<uid>/fire

Clear an Alert

URL

POST https://mpulse.soasta.com/concerto/mpulse/api/alerts/<uid>/clear

Body

None

Response

If the clear is successful, the response will be 204 (No Content).

Example

curl -X POST https://mpulse.soasta.com/concerto/mpulse/api/alerts/<uid>/clear

Errors

The Alert API uses the following error codes:

Error Code Description
400 Bad request. The URL or JSON is invalid.
404 Not found. The requested object does not exist.
409 The alert is disabled. Enable the alert in the UI and try again.
429 The number of API requests object exceeds the rate limits.
500 Internal server error. Try again later.