Overview

List Webhook Events

List all available webhook events that you can subscribe to, with basic details about each event. Use the optional `model` query parameter to filter events for a specific model type (for example, `WorkOrder` or `Provider`).

List Webhooks

Retrieve a paginated list of webhooks configured for your company, with filters for status, search, sorting, and selected fields. Use this endpoint to quickly review and manage existing webhook configurations.

Create Webhook

Create a new webhook configuration for your company by providing the target URL, HTTP method, subscribed events, and status. After creation, the webhook receives notifications for the selected events and is assigned a unique `webhookId` for future operations.

List Delivery Logs

Retrieve a paginated list of webhook delivery attempts, including successful deliveries, failures, and retries. Filter results by webhook ID, work order ID, event name, or delivery status to monitor reliability and troubleshoot issues.

Get Delivery Log Details

Retrieve detailed information about a single webhook delivery attempt, including status, timestamps, and a pre-signed URL to the full log file. Use this endpoint to investigate why a specific delivery succeeded or failed.

Retry Delivery Log

Retry a previously failed webhook delivery by its `deliveryId`, creating a new delivery job for the same payload. Use this endpoint after fixing issues on your endpoint to reprocess specific events and track the retry by job ID.

Get Webhook Details

Retrieve detailed information about a single webhook configuration, including subscribed events, status, and key settings. Use `fields` and `webhookAttribute` query parameters to control which core fields and additional attributes are returned.

Delete Webhook

Permanently delete a webhook configuration so it no longer receives notifications. Delivery logs and history remain available for auditing, but the webhook itself cannot be recovered.

Update Webhook

Update an existing webhook configuration, such as the endpoint URL, HTTP method, subscribed events, status, or notification email. Only the fields you include in the request body are changed; omitted fields keep their current values.

List Webhook History

Retrieve a paginated change history for a single webhook, including who made each change, what changed, and when it occurred. Use this audit trail to track configuration updates and troubleshoot issues.

Delete Webhook Attribute

Remove a specific webhook attribute (for example, a custom header or legacy field mapping) by its type and name. Use this endpoint to clean up attributes that are no longer needed on a webhook.