Links
It is possible to include a callbackURL and an externalLink value in the payload - both are optional. This allows you to establish links between matched records on both sides. For example, you can allow your own users to directly open the matching record in Booster from within your own repair record - and you can allow Booster users to directly open to the matched repair record in your system from within the Booster record.
Both links are sent in the links object of a POST to the /repair endpoint.
"links": {
"callbackURL": "string",
"externalLink": "string"
}
callbackURL
Provide your own callback URL here and after successful processing of your payload, BodyShop Booster will send a POST to that URL with a direct link to the repair record in BodyShop Booster.
Example content sent to callback URL:
{
"boosterRepairLink": "https://crm.bodyshopbooster.com/external/95134aa6-2c61-4f96-a457-261569a59eb4"
}This allows you to add functionality inside your application, for example adding a button in each record on your end that when clicked directly opens the corresponding record in Booster.
externalLink
Provide a direct link to the repair record in your system here, and BodyShop Booster will automatically add that link in each repair record updated by your system inside Booster.
Booster admins can customise the text and icon they want to use for this link - the example below shows “Open in External System”
This functionality is off by default. To enable, the customer can request that the BodyShop Booster support desk turn it on for them, alternatively they can do this themselves with the following steps:
Log in to Bodyshop Booster with an admin account
Go to Admin → Integrations → Booster OpenAPI
Edit the API key used by your application
Toggle on the switch next to ‘Enable External Linking’
Enter the text to be used for ‘External Link Name’
Pick an icon to be used
Press Save