Skip to navigation
HINDSITE APIalerts

Post Alerts

View as Markdown

Authentication

AuthorizationBearer

OAuth 2.0 Client Credentials Flow. To obtain an access token:

  1. Request API credentials from HINDSITE support to receive your client_id and client_secret

  2. Make a POST request to obtain an access token:

POST https://app.hindsiteind.com/oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET
  1. The response will contain your access token:
{
  "access_token": "your_access_token_here",
  "token_type": "Bearer",
  "expires_in": 7200,
  "created_at": 1234567890
}
  1. Include the token in subsequent API requests:
Authorization: Bearer your_access_token_here

Request

This endpoint expects an object.
form_step_idstringRequired
messagestringOptional
recipient_user_idslist of stringsOptional

Users to notify. Each must be able to see the form’s work order (as served by GET /work_orders/{id}/alertable_users) and must not be the sender; any invalid id fails the whole request with 422. Omitted or empty, the alert goes to the work order’s operational leads.

Response

Alert dispatched; empty response