> 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. # Create a webhook POST https://app.hindsiteind.com/api/v2/webhooks Content-Type: application/json Subscribes a URL to one or more events (REST-hook style, as used by Zapier, Make and Power Automate). Unknown event names are dropped; the response shows the events that were kept. Store the returned `signing_secret` to verify deliveries. Reference: https://api-docs.hindsiteind.com/hindsite-api/webhooks/post-webhooks ## 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 ``` ## Request ### Body (application/json) This endpoint expects a WebhookCreateRequest. - `url` (string, required) — http or https URL to receive event payloads. - `subscribed_actions` (list of string, required) — Event names from **List subscribable events**. Unknown names are ignored. - `name` (string, optional) — Optional label. Defaults to `API subscription`. ## Response ### 201 The new webhook - `id` (string, optional) - `name` (string, optional) — Label shown in Settings › Webhooks. - `url` (string, optional) — Where event payloads are POSTed. Must be http or https and resolve to a public address. - `active` (boolean, optional) — Inactive webhooks receive no deliveries. A webhook is deactivated automatically after sustained delivery failures and can be reactivated in Settings › Webhooks. - `subscribed_actions` (list of string, optional) — Event names this webhook receives, from **List subscribable events**. - `signing_secret` (string, optional) — HMAC-SHA256 key for the `X-Webhook-Signature` header on every delivery. - `created_at` (datetime, optional) - `updated_at` (datetime, optional) ## Errors ### 400 Bad Request Error `url` or `subscribed_actions` missing - `any` ### 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` ### 422 Unprocessable Entity Error The URL is not http or https, or the webhook is otherwise invalid. The body carries an `error` message. - `any` ## Examples **Request** ```json { "url": "string", "subscribed_actions": [ "work_order_created", "form_completed" ] } ``` **Response** ```json { "id": "string", "name": "string", "url": "string", "active": true, "subscribed_actions": [ "string" ], "signing_secret": "string", "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z" } ``` **SDK Code** ```python import requests url = "https://app.hindsiteind.com/api/v2/webhooks" payload = { "url": "string", "subscribed_actions": ["work_order_created", "form_completed"] } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://app.hindsiteind.com/api/v2/webhooks'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"url":"string","subscribed_actions":["work_order_created","form_completed"]}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://app.hindsiteind.com/api/v2/webhooks" payload := strings.NewReader("{\n \"url\": \"string\",\n \"subscribed_actions\": [\n \"work_order_created\",\n \"form_completed\"\n ]\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://app.hindsiteind.com/api/v2/webhooks") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"url\": \"string\",\n \"subscribed_actions\": [\n \"work_order_created\",\n \"form_completed\"\n ]\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://app.hindsiteind.com/api/v2/webhooks") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"url\": \"string\",\n \"subscribed_actions\": [\n \"work_order_created\",\n \"form_completed\"\n ]\n}") .asString(); ``` ```php request('POST', 'https://app.hindsiteind.com/api/v2/webhooks', [ 'body' => '{ "url": "string", "subscribed_actions": [ "work_order_created", "form_completed" ] }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://app.hindsiteind.com/api/v2/webhooks"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"url\": \"string\",\n \"subscribed_actions\": [\n \"work_order_created\",\n \"form_completed\"\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "url": "string", "subscribed_actions": ["work_order_created", "form_completed"] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://app.hindsiteind.com/api/v2/webhooks")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data 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() ```