Estimator webhooks FAQ

Article Introduction

Webhooks in the Estimator send data to external systems when events occur. This FAQ covers common questions about how webhooks work, what data is sent, and the requirements for receiving that data.

What Events Can Trigger Webhooks in the Estimator?

Webhooks can be triggered by events related to:

• Jobs
• Estimates
• Documents
• Payments

Each selected event will send data when that action occurs.

What Does a Webhook Send?

A webhook sends a data payload to the configured endpoint.

This payload contains information about the event, including:

• The type of event
• A unique event identifier
• The related data for that event

How Is Webhook Data Structured?

Webhook payloads follow a structured format that includes:

• Event information
• Associated object data (such as jobs or estimates)

Data is organized based on objects within the system.

What Are the Requirements for a Webhook Endpoint?

The receiving endpoint must:

• Accept incoming HTTP requests
• Return a 2xx HTTP status code

A successful response confirms that the webhook was received.

If a valid response is not returned, the delivery will be considered failed.

What Happens if the Endpoint Does Not Respond Correctly?

If the endpoint fails to return a valid response:

• The webhook delivery will fail
• The system will attempt to resend the webhook

Can Webhooks Modify Data in the Estimator?

No.

Webhooks only send data out of the Estimator and cannot:

• Create records
• Update records
• Delete records