Configure webhooks

Last updated: July 28, 2026

You can configure webhooks to send real-time notifications about events in Installer.com to external systems, enabling seamless integrations.

Configure a webhook

  1. Navigate to your Integrations settings within the app.

  2. Select the option to Add new webhook.

  3. Enter the Webhook URL where Installer.com will send event notifications.

  4. Select the Events that will trigger the webhook, such as "Order Created" or "Job Status Updated".

  5. Customize the Payload structure using Handlebars templates to define the data sent with each notification.

    • All template values are automatically JSON-escaped to ensure correct handling of special characters like quotes and ampersands in the payload.
    • To include details for multiple product lines, use the {{#each}} Handlebars helper. This iterates through a list of items, such as products associated with an order.

    For example, to list products in an order payload:

    {
      "orderId": "{{order.id}}",
      "customerName": "{{order.customer.name}}",
      "products": [
        {{#each order.products}}
        {
          "productId": "{{this.id}}",
          "name": "{{this.name}}",
          "quantity": "{{this.quantity}}"
        }{{/each}}
      ]
    }
    

    Additionally, for webhook events involving actors (e.g., an installer or a customer), the organizationExternalId field may be exposed. This field provides the external ID of the actor's organization and is only included in the payload if the actor belongs to an organizational hierarchy where an external ID is relevant.

  6. Save your webhook configuration.

Webhook Task Status

The status of a webhook task is determined by the HTTP response code received from the configured Webhook URL:

  • Success: An HTTP status code in the 2xx range (e.g., 200 OK, 201 Created) indicates that the webhook task was successful.
  • Retry: An HTTP status code in the 4xx range (e.g., 400 Bad Request, 404 Not Found) or 5xx range (e.g., 500 Internal Server Error, 503 Service Unavailable) will cause the webhook task to be retried.
  • Failed: If a webhook task consistently receives retryable HTTP status codes after multiple attempts, it will eventually be marked as failed.

Related articles

Need help? Contact Installer.com support.