{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"19de7a01-4bb6-41cd-a0a3-8aa4c6841ba9","name":"Relocity Webhooks","description":"### Overview\n\nRelocity provides specified Webhook request endpoints for specific actions. Each Webhook request will require authentication and Relocity supports Oauth 2.0.\n\n#### OAuth 2.0 Authentication\n\nOAuth 2.0 is the industry-standard protocol for authorization and is recommended as the method to Authenticate with Relocity services.\n\nTo authenticate individual HTTPS requests with the Relocity, the service provider will request a short-lived JWT access token using a Client Id and Client Secret. Once an access token is obtained, it will be sent in a header as `Authorization : Bearer {Auth Token}` to authenticate all requests.\n\n##### Requesting an Access Token\n\nTo retrieve a token using the client_credentials grant type, make a POST request to the *oauth/token endpoint*:\n\n| Configuration | Value | Descriptions |\n| --- | --- | --- |\n| grant_type | client_credentials | The client credentials grant is suitable for machine-to-machine authentication. |\n| client_id | YOUR CLIENT IDENTIFIER | Obtain the client_id by contacting [developers@relocity.com](mailto:developers@relocity.com) |\n| client_secret | YOUR SECRET | Obtain the client_id by contacting [developers@relocity.com](mailto:developers@relocity.com) |\n| scope | YOUR SCOPE | Obtain a scope by contacting [developers@relocity.com](mailto:developers@relocity.com) |\n\n**Example Request**\n\n```\ncurl -X \"POST\" \"https://{{base_url}}/oauth/token\" \\\n     -H 'Content-Type: application/x-www-form-urlencoded; charset=utf-8' \\\n     --data-urlencode \"grant_type=client_credentials\" \\\n     --data-urlencode \"client_id=client-id\" \\\n     --data-urlencode \"client_secret=client-secret\" \\\n     --data-urlencode \"scope=your-scope\"\n\n```\n\n**200 OK Reponse**\n\n```\n{\n  \"token_type\": \"Bearer\",\n  \"expires_in\": 36000,\n  \"access_token\": \"{ACCESS TOKEN}\"\n}\n\n```\n\n**401 Unauthorized**\n\n```\n{\n  \"error\": \"invalid_client\",\n  \"error_description\": \"Client authentication failed\",\n  \"message\": \"Client authentication failed\"\n}\n\n```\n\n##### Making a Request with an Auth Token\n\nWhen using OAuth 2.0 Authentication all requests must be made with the short-lived access token.\n\n**Example Request Header**:\n\n| Key | Value |\n| --- | --- |\n| Authorization | Bearer {ACCESS TOKEN} |\n\n##### Obtaining a Client ID & Secret\n\nPlease contact [developers@relocity.com](mailto:developers@relocity.com) to obtain a Client ID & Secret.\n\n##### Headers\n\n`Accept: application/json`\n\n##### Content Type\n\nThe content type should be set to `application/json`\n\nThe incoming work order webhook accepts authorizations from authorized parties.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6824100","team":290936,"collectionId":"19de7a01-4bb6-41cd-a0a3-8aa4c6841ba9","publishedId":"Szmh4Htj","public":true,"publicUrl":"https://webhook-docs.relocity.com","privateUrl":"https://go.postman.co/documentation/6824100-19de7a01-4bb6-41cd-a0a3-8aa4c6841ba9","customColor":{"top-bar":"FFFFFF","right-sidebar":"000000","highlight":"FF7F7E"},"documentationLayout":"classic-single-column","customisation":null,"version":"8.10.1","publishDate":"2020-08-06T15:23:06.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Core Platform Development","id":"025318b7-62eb-4232-858a-0bcc5902694b","owner":"6824100","values":[{"key":"domain","value":"api-dev.relocity.com","enabled":true},{"key":"prefix","value":"api/v1","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/2944dd18b9d62b4154e9afe66a1628ef88a5791d8985f1ae0a4f6726fd441715","favicon":"https://res.cloudinary.com/postman/image/upload/v1551655576/team/cvm35ztifqay2un7vbqg.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Core Platform Development","value":"6824100-025318b7-62eb-4232-858a-0bcc5902694b"}],"canonicalUrl":"https://webhook-docs.relocity.com/view/metadata/Szmh4Htj"}