> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api-docs.hindsiteind.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api-docs.hindsiteind.com/_mcp/server.

# List subscribable events

GET https://app.hindsiteind.com/api/v2/webhooks/events

Returns the event names a webhook can subscribe to, grouped by category. Use it to populate an event picker; the keys are stable category names and the values are the exact strings to pass in `subscribed_actions`.

Reference: https://api-docs.hindsiteind.com/hindsite-api/webhooks/get-webhook-events

## Authentication

- `Authorization` header (bearer token, required) — 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 ``` 3. The response will contain your access token: ```json { "access_token": "your_access_token_here", "token_type": "Bearer", "expires_in": 7200, "created_at": 1234567890 } ``` 4. Include the token in subsequent API requests: ``` Authorization: Bearer your_access_token_here ```

## Response

### 200

Event names by category

- `map from string to list of string`

## Errors

### 402 Payment Required Error

The organisation's plan does not include API integrations. The body carries `feature` (`api_integrations`) and an `upgrade_url`.

- `any`

### 403 Forbidden Error

Caller is not an admin in the organisation

- `any`

## Examples

**Response**

```json
{
  "work_orders": [
    "work_order_created",
    "work_order_updated",
    "work_order_cancelled",
    "work_order_reactivated",
    "work_order_placed_on_hold",
    "work_order_resumed",
    "work_order_deferred",
    "work_order_taken_up",
    "work_order_permanently_deleted",
    "work_order_linked",
    "work_order_unlinked",
    "work_order_asset_assigned",
    "work_order_asset_unassigned",
    "work_order_location_added",
    "work_order_location_removed",
    "work_order_group_added",
    "work_order_group_removed",
    "work_order_manager_assigned",
    "work_order_manager_unassigned",
    "work_order_participant_assigned",
    "work_order_participant_unassigned",
    "work_order_operational_lead_assigned",
    "work_order_operational_lead_unassigned",
    "work_order_user_unassigned",
    "work_order_project_added",
    "work_order_project_removed",
    "work_order_section_created",
    "work_order_section_renamed",
    "work_order_section_deleted",
    "work_order_moved_to_section",
    "work_order_tasks_moved_to_section",
    "work_order_schedule_created",
    "work_order_schedule_updated"
  ],
  "work_order_tasks": [
    "work_order_task_permanently_deleted"
  ],
  "work_order_templates": [
    "work_order_template_created",
    "work_order_template_updated",
    "work_order_template_cancelled",
    "work_order_template_reactivated",
    "work_order_template_asset_assigned",
    "work_order_template_asset_unassigned",
    "work_order_template_location_added",
    "work_order_template_location_removed",
    "work_order_template_group_added",
    "work_order_template_group_removed",
    "work_order_template_manager_assigned",
    "work_order_template_manager_unassigned",
    "work_order_template_participant_assigned",
    "work_order_template_participant_unassigned",
    "work_order_template_operational_lead_assigned",
    "work_order_template_operational_lead_unassigned",
    "work_order_template_project_added",
    "work_order_template_project_removed",
    "work_order_template_section_created",
    "work_order_template_section_renamed",
    "work_order_template_section_deleted",
    "work_order_template_moved_to_section",
    "work_order_template_tasks_moved_to_section",
    "work_order_template_schedule_created",
    "work_order_template_schedule_updated"
  ],
  "reports": [
    "form_created",
    "form_completed",
    "form_title_changed",
    "form_unapproved",
    "form_approval_approved",
    "form_approval_revoked"
  ],
  "defects": [
    "defect_created",
    "defect_updated",
    "defect_work_started",
    "defect_marked_ready",
    "defect_rework_requested",
    "defect_approved",
    "defect_completed",
    "defect_cancelled",
    "defect_reopened",
    "defect_commented"
  ],
  "reviews": [
    "review_approved",
    "review_rejected",
    "review_commented",
    "reviewer_requested",
    "reviewer_removed",
    "reviewer_reminded",
    "reviewer_re_requested",
    "reviewer_revoked",
    "reviewer_reinstated"
  ],
  "assets": [
    "asset_created",
    "asset_updated",
    "asset_status_online",
    "asset_status_offline",
    "asset_permanently_deleted"
  ],
  "locations": [
    "location_created",
    "location_updated",
    "location_permanently_deleted"
  ],
  "companies": [
    "company_created",
    "company_updated",
    "company_permanently_deleted"
  ],
  "tools": [
    "tool_created",
    "tool_updated",
    "tool_retired",
    "tool_inspected",
    "tool_inspection_rescheduled"
  ],
  "actions": [
    "action_created",
    "action_updated",
    "action_content_added",
    "action_content_removed"
  ],
  "notes": [
    "note_created",
    "note_updated",
    "note_destroyed"
  ],
  "documents": [
    "document_added",
    "document_removed"
  ],
  "work_instructions": [
    "instruction_revision_created",
    "instruction_revision_updated"
  ],
  "exports": [
    "report_export_completed"
  ]
}
```

**SDK Code**

```python webhooks_getWebhookEvents_example
import requests

url = "https://app.hindsiteind.com/api/v2/webhooks/events"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript webhooks_getWebhookEvents_example
const url = 'https://app.hindsiteind.com/api/v2/webhooks/events';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go webhooks_getWebhookEvents_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.hindsiteind.com/api/v2/webhooks/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby webhooks_getWebhookEvents_example
require 'uri'
require 'net/http'

url = URI("https://app.hindsiteind.com/api/v2/webhooks/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java webhooks_getWebhookEvents_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://app.hindsiteind.com/api/v2/webhooks/events")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php webhooks_getWebhookEvents_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.hindsiteind.com/api/v2/webhooks/events', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp webhooks_getWebhookEvents_example
using RestSharp;

var client = new RestClient("https://app.hindsiteind.com/api/v2/webhooks/events");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift webhooks_getWebhookEvents_example
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://app.hindsiteind.com/api/v2/webhooks/events")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```