Configure the webhook in Consul

Configure webhook endpoints so that Consul can use the endpoint to communicate with Incident Response.

Before you begin

Role required: Responder, Manager, or Administrator

About this task

Note: While this integration with a third-party product is supported, the documentation here is based upon information provided by that third-party. More current information about the operation of that third-party’s system may be available from them directly.


  1. Create a Consul configuration directory, consul.d.
  2. Download the script file and move it to the consul.d/scripts directory. 
  3. Update the webhook URL value in the script file with the webhook URL copied from Incident Response.   
    Paste webhook URL from LIR.
  4. Inside consul.d, create the agent configuration file, add the watches parameter, and enable script check.
    Watches must have the type parameter value as checks and the args parameter must point to the script path.
    Figure 1. Sample agent configuration file
    Sample agent configuration file.
  5. Add the checks parameter to either the agent configuration file or in the service itself to enable monitoring for the service.

    Health checks must have check ID defined and it should be unique for each service.

    Checks parameter.
  6. Start the consul agent.


Whenever there is a change in the health check status of services registered in Consul, it generates an alert in the Lightstep Incident Response.
Note: The Lightstep Incident Response integration with Consul supports both OPEN Source and HCP Cloud setup.