Register Webhook

Overview

This endpoint allows you to establish a webhook subscription, enabling Hover to send real-time status updates and event notifications directly to your system.

Webhooks are your primary mechanism for receiving automated, asynchronous updates from Hover regarding processes and events relevant to your organization. By creating a webhook, you designate a specific URL where Hover will send event payloads as they occur.

Webhook Functionality

• Real-time Notifications: Once configured, Hover will send an HTTP POST request to your specified URL whenever a relevant event occurs within your organization.
• Organizational Scope: The webhook operates within the scope of the organization you are authenticated under. It will report on events from all users within that organization, regardless of whether jobs were created through the Hover mobile app or API.
• Verification Process: Upon successful webhook creation, Hover will immediately send a POST request to your designated URL containing a verification code. You must respond to this verification request as specified in our Webhook Guide to confirm the webhook's validity.
• Event Structure: Each webhook notification will include an "event" attribute in its payload, indicating the type of event that occurred (e.g., job-state-changed). The rest of the payload will contain data specific to that particular event.

Learn More

• Guide on Webhooks and Events-Based Architecture
• Information on the events sent by Hover
• Webhook Signature Verification