Go to the Settings Page #
Open the Settings page by clicking your name in the top right and then Settings.
Go to the Webhook Settings Page #
From the Settings page, find the Email & Integrations section and click on the Webhooks link.
Add a new Webhook or Edit an Existing One #
If you are adding a new Webhook trigger, simply click the Add a New Webhook button, or click on the Webhook you wish to edit in the table.
Enter/Edit the Webhook Details #
The Webhook Name and the Active status can be set here (a). The Webhook name is an internal reference you can use for a descriptive title of the webhook trigger. The active toggle is simply to set whether you want this trigger to be active on your Repair Pilot or not – useful when setting up and testing.
The trigger status and method can be set here (b). The status is where you would select which job status would trigger this webhook (if you want to trigger a webhook for more than one status, simply create a new webhook for that status. The Method is how you want the webhook to be delivered – options are POST or GET.
The Webhook Endpoint (c) is the URL you want to deliver the payload to. This needs to be a complete url and should be to a HTTPS address.
Enter/Edit any Required Header Details #
The header details are usually provided by the service you are sending the Repair Pilot details to. These can be blank if they are not needed, or you can enter details such as API keys, bearer tokens etc. These are used for security purposes. They must be entered is a JSON array format, for example:
{
"Authorisation" : "Bearer abc123"
}
Select the Field Data you Want to Send #
Next, select the fields you want to include in the payload. Simply select the fields from the dropdown and the Body Fields box will be automatically populated with the sample JSON that will be sent to your webhook endpoint.
Review the JSON Payload #
Once you have selected all of the required fields to be sent, you should have something similar to the screenshot below.
Edit the Payload Alias Names (If Required) #
If you require the data to have specific variable names when they are sent, you can edit them in Body Fields box. The example below shows how you could change the Customers name alias from “display_name” to “customer_name”.
Please Note: Do not edit the text to the right of each : as these are converted by our system the the actual data – if these are changed, the webhook will fail.
Save the Webhook #
Once you have finished adding/editing the webhook details, please make sure you click the Add New/Save button at the bottom right of the screen.
