Web hook events

Crittah allows you to send job update events to another system automatically when a job changes to a new status. This allows you to call another system to trigger a business process when a job changes to a predefined status.

For example you may want to send out a survey when a job is closed asking for customer feedback. Crittah will call your external system posting all job details to the remote API when the job is closed. The remote API can use all of the details in the job to then send out a personal email to the customer asking them for feedback relevant to the job that was completed.

Before you can setup automated a web API hook event you will need to have setup the remote API configuration.


Setup remote API

Navigate to Admin → Administration

Select "Web Hook Configuration" from the Integration section of the Administration page.

Setup the configuration for you external API that you would like to call and make sure you set the "Web hooks enable" checkbox to checked and then click "Save"

Configure Web API Hook event

To create an automated web API hook event for a job, navigate to Admin-> Administration and select "Job type configuration" under the "Job Configurations" section. Search for the job type you would like to create an automated email event for. 

Under "Job type configuration" view click on the "Add event action" button.

Select the status that will trigger the web hook event and the template to be used.

This means when the job changes to this status a web API hook call will be made to an external URL providing the job details in the body of the POST call.


Click Add and you will be returned to the "Job type configuration" screen. You will now see that this new event has been configured.

To remove this event just click on the Trash can icon () next to that event.