Skip to main content

Programmatic, On-Demand Alert Triggering

Trigger an alert via the Rupert API

Adi Cohen avatar
Written by Adi Cohen
Updated over 2 months ago

Rupert allows you to trigger alerts on demand. To enable programmatic triggering, navigate to the Alert Trigger section and choose the "On Demand" option under "Choose Sampling Frequency" (see image below).
​

Once set to "On Demand," alerts can only be triggered via API.

Triggering Alerts via API

For automation, users must trigger alerts programmatically using the Rupert API. Below is the API documentation for triggering alerts by ID.

Endpoint

POST https://api-v1.hirupert.com/api/v1/alerts/{alert_id}/runs

Request Details

  • Host: api-v1.hirupert.com

  • Authorization: Users need to contact us to obtain an API key.

  • Path Parameter: {alert_id} – The unique ID of the alert, which can be found in the URL when opening an alert in the web app.

    Example: If the alert URL is https://my_company.hirupert.com/webapp/alert/1359, then the alert ID is 1359.

Headers

{     "Authorization": "Bearer YOUR_API_KEY",     "Content-Type": "application/json" }

Response Codes and Messages

Success Response (200 OK)

If the alert is successfully triggered, the API returns:

{     "status": "success" }

Error Responses

Status Code

Error Message

Reason

400 Bad Request

{ "detail": { "title": "Failed to trigger alert - Bad Request", "message": "Alert is paused" } }

The alert is paused and cannot be triggered.

400 Bad Request

{ "detail": { "title": "Failed to trigger alert - Bad Request", "message": "Alert is scheduled to run within the next 15 minutes" } }

The alert was triggered recently and is scheduled to run soon.

404 Not Found

{ "detail": { "title": "Failed to trigger alert - Not Found" } }

The alert does not exist or has been deleted.

Use Case: Running Alerts After Data Updates

This API is particularly useful for triggering alerts right after ETL jobs or data syncs complete. Automating alert execution ensures that reports and notifications reflect the latest data.

For any issues or to request API access, please contact our support team.

Did this answer your question?