Jobi Web Hook
API - Jobi Web Hook
Do Connect API
Our API is used to connect Thirdy Party Applications to Best Ever Flat Rate data.
GetThis is the API url path used for connecting to our LIVE (Production) server
This path is used for connecting to DEVELOPMENT (Sandbox) server
Parameters
Description : Organization Identifier/key from the 3rd party platform. This key needs to be provided to us by third parties before integration and then configured manually in our Jobi admin by our support staff.
Example : cdde3f63-f26c-4d7d-89b6-110558e99027
Description : fixed value Jobi staff will provide this to you.
Example : your_company
Description : The is the url Jobi App users will be redirected to after they finish their tasks on Jobi. This is a page created by and hosted by third party clients to receive data. The response (mentioned below) will be provided on POST to this URL
Example : http://jobi.pro/contractor/thirdparty/call_back/response
Description : Client Name
Example : Mr. Joe Smith
Description : Client Email
Example : client@email.com
Description : Job Number
Example : 123909
Description : Client Phone Number
Example : 999999999
Description : Client Address
Example : 12 Old Town Road
Description : Client City
Example : Albany
Description : Client State
Example : NY
Description : Client Zip Code
Example : 12207
Description : Call Attend Date
Example : 2014-04-08 (YYYY-MM-DD)
Description : Department
Example : Heating Department
Description : Job
Example : Furnace Rebuild
* fields are mandatory
Success Response:
Once the connection has been established successfully with Do Connect API, the Jobi will open our native app or web app for users. After submitting the JOB CALL (Submit Call on our App) the user will be redirected to the Call Back URL with response data.
{
"status": true,
"response_data": {
"call_details": {
"call_id": "8690",
"department_name": "Heating",
"job_name": "Furnace",
"job_number": "123789",
"client_name": "Mr. X",
"client_email": "x@mail.com",
"address": "12 Old Town Road",
"city": "Carmel",
"state": "NY",
"zip": "10512",
"phone_number": "999999999",
"show_phone_number": "1",
"call_notes": ""
},
"option_sheets": [
{
"option_titles": [
{
"service": {
"id": "2328",
"plan_name": "5 Year \"Can't Write a Check\" Service Plan",
"description": "10 yearly maintenance visits with priority service",
"duration": "5",
"price": "200"
},
"options": [
{
"options_id": "93977",
"optionNo": "AMH80403AN",
"qty": "1",
"orgID": "140",
"jobID": "16200",
"optionType": "fixed",
"pricelevelId": "0",
"options_name": "Standard (M) Dual Output Heating System - AMH80403AN",
"optionDesc": "Amana 80% Upflow/Horizontal, Twin Comfort 2-stage, 1.5 Ton, 14 wide - AMH80403AN - KBTU OUT 36",
"costParts": "0.00",
"hours": "6.00",
"finalPrice": "5273.41",
"standard_price": 0,
"club_price": "5273.41"
},
{
"options_id": "93978",
"optionNo": "AMH80603AN",
"qty": "1",
"orgID": "140",
"jobID": "16200",
"optionType": "fixed",
"pricelevelId": "0",
"options_name": "Standard (L) Dual Output Heating System - AMH80603AN",
"optionDesc": "Amana 80% Upflow/Horizontal, Twin Comfort 2-stage, 2 Ton, 14 wide - AMH80603AN - KBTU OUT 56",
"costParts": "0.00",
"hours": "6.00",
"finalPrice": "5502.96",
"standard_price": 0,
"club_price": "5502.96"
},
{
"options_id": "93979",
"optionNo": "AMH80803BN",
"qty": "1",
"orgID": "140",
"jobID": "16200",
"optionType": "fixed",
"pricelevelId": "0",
"options_name": "Standard (XL25) Dual Output Heating System - AMH80803BN",
"optionDesc": "Amana 80% Upflow/Horizontal, Twin Comfort 2-stage, 2.5 Ton, 17.5 wide - AMH80803BN - KBTU OUT 72",
"costParts": "0.00",
"hours": "6.00",
"finalPrice": "5681.96",
"standard_price": 0,
"club_price": "5681.96"
}
],
"warranty": {
"id": "2487",
"plan_name": "5 Year Warranty",
"description": "Terms here",
"duration": "5",
"is_warrany_price_fixed": "0",
"price": "0"
},
"option_title": {
"id": "1910",
"name": "Platinum Plus"
},
"custom_option_title": "The Best of the Best",
"financing_option": "",
"price": "18281.25",
"selected": "1"
},
{
"service": {
"id": "2322",
"plan_name": "3 Year \"Can't Write a Check\" Service Plan",
"description": "3 yearly maintenance visits with priority service",
"duration": "3",
"price": "249"
},
"options": [
{
"options_id": "93977",
"optionNo": "AMH80403AN",
"qty": "1",
"orgID": "140",
"jobID": "16200",
"optionType": "fixed",
"pricelevelId": "0",
"options_name": "Standard (M) Dual Output Heating System - AMH80403AN",
"optionDesc": "Amana 80% Upflow/Horizontal, Twin Comfort 2-stage, 1.5 Ton, 14 wide - AMH80403AN - KBTU OUT 36",
"costParts": "0.00",
"hours": "6.00",
"finalPrice": "5273.41",
"standard_price": 0,
"club_price": "5273.41"
},
{
"options_id": "93978",
"optionNo": "AMH80603AN",
"qty": "1",
"orgID": "140",
"jobID": "16200",
"optionType": "fixed",
"pricelevelId": "0",
"options_name": "Standard (L) Dual Output Heating System - AMH80603AN",
"optionDesc": "Amana 80% Upflow/Horizontal, Twin Comfort 2-stage, 2 Ton, 14 wide - AMH80603AN - KBTU OUT 56",
"costParts": "0.00",
"hours": "6.00",
"finalPrice": "5502.96",
"standard_price": 0,
"club_price": "5502.96"
},
{
"options_id": "93979",
"optionNo": "AMH80803BN",
"qty": "1",
"orgID": "140",
"jobID": "16200",
"optionType": "fixed",
"pricelevelId": "0",
"options_name": "Standard (XL25) Dual Output Heating System - AMH80803BN",
"optionDesc": "Amana 80% Upflow/Horizontal, Twin Comfort 2-stage, 2.5 Ton, 17.5 wide - AMH80803BN - KBTU OUT 72",
"costParts": "0.00",
"hours": "6.00",
"finalPrice": "5681.96",
"standard_price": 0,
"club_price": "5681.96"
},
{
"options_id": "93980",
"optionNo": "AMH80804CN",
"qty": "1",
"orgID": "140",
"jobID": "16200",
"optionType": "fixed",
"pricelevelId": "0",
"options_name": "Standard (XL30) Dual Output Heating System - AMH80804CN",
"optionDesc": "Amana 80% Upflow/Horizontal, Twin Comfort 2-stage, 3.0 Ton, 21 wide - AMH80804CN - KBTU OUT 72",
"costParts": "0.00",
"hours": "6.00",
"finalPrice": "5681.96",
"standard_price": 0,
"club_price": "5681.96"
},
{
"options_id": "93981",
"optionNo": "AMH80805CN",
"qty": "1",
"orgID": "140",
"jobID": "16200",
"optionType": "fixed",
"pricelevelId": "0",
"options_name": "Standard (XL35) Dual Output Heating System - AMH80805CN",
"optionDesc": "Amana 80% Upflow/Horizontal, Twin Comfort 2-stage, 3.5 Ton, 21 wide - AMH80805CN - KBTU OUT 72",
"costParts": "0.00",
"hours": "6.00",
"finalPrice": "6190.96",
"standard_price": 0,
"club_price": "6190.96"
}
],
"warranty": {
"id": "2481",
"plan_name": "3 Year Warranty",
"description": "Terms",
"duration": "3",
"is_warrany_price_fixed": "0",
"price": "0"
},
"option_title": {
"id": "1912",
"name": "Platinum"
},
"custom_option_title": "",
"financing_option": "",
"price": "29928.19",
"selected": "0"
}
],
"name": "Low on Refrigerant ",
"system_observations": "12 yrs old AC \nMaintained by others\nBlowing warm air\nLow on refrigerant",
"tech_notes": "",
"option_sheet_total": "18281.25"
}
],
"user_id": "20"
}
}
Response Fail:
For Invalid Parameters
{
"status": false,
"message": "requried client_key,client_identifier,call_back_url,name,number parameters"
}
Response Fail:
When Third Party clients are not registered with Jobi platform or API is receiving the wrong client key / identifier
{
"status": false,
"message": "record not found"
}