Skip to content
English
Customer portal Sign in
Go to One Click Contractor
  • There are no suggestions because the search field is empty.

What Is a Webhook and How do They Interact with OCC

Learn what a webhook is and how it is used to send data from One Click Contractor to other systems

Article Introduction

A webhook is a feature that allows One Click Contractor to send data to another system when specific events occur. Webhooks are event-driven, meaning they trigger automatically when an action happens.

What a Webhook Does

A webhook sends a data payload to a specified URL each time an event occurs.

  • The payload contains information related to the event
  • Data can include information that was created, updated, or removed

These events are referred to as webhook events.

How Webhooks Work

Webhooks operate using an event-driven model.

  • When an event happens, data is automatically sent to the configured endpoint
  • There is no need to request or poll for updates

This is different from a traditional API, where systems repeatedly request data on a schedule.

Webhook vs Traditional API

With a traditional API:

  • A system continuously requests data (polling)

With a webhook:

  • Data is sent automatically when an event occurs

polling_vs_webhooks

This approach is often described as:
“Don’t call me, I’ll call you.”

How Webhooks Are Used

Webhooks can be used to trigger actions in external systems when events occur in One Click Contractor.

Examples include:

  • Sending notifications when a job is created or updated
  • Triggering actions when an estimate is created or updated
  • Responding to signed or completed documents