Webhooks

Webhooks enable your application to receive real-time notifications when specific events occur in our system. Instead of polling for changes, you can register a webhook URL where we'll POST event data as it happens.

Webhooks are reliable, secure, and configurable; you can choose which events you want to subscribe to and manage multiple endpoints. In the case of a webhook failure, we will retry the delivery according to our retry policy, ensuring that you don't miss important updates.

Typical use cases include syncing data across systems, triggering workflows in external tools, and auditing activity in near real time.

Webhooks can be setup and easily managed through the Harlyy dashboard, where you can also view logs of past webhook requests and their statuses.

The Webhook Object

Schema Webhook not found in OpenAPI spec.

Retrieve Webhooks

Retrieve webhooks for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the webhooks for.

Returns200

The webhooks.

The Webhook Object

Endpoint

GET /v2/businesses/{business}/webhooks

Retrieve a Webhook

Retrieve a webhook for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the webhook for.

webhookstringPath RequiredField must be in path.

The ID of the webhook to retrieve.

Returns200

The webhook was found.

The Webhook Object

Endpoint

GET /v2/businesses/{business}/webhooks/{webhook}

Create a Webhook

Create a webhook for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the webhooks for.

Schema undefined not found in OpenAPI spec.

Returns201

The webhook was created.

The Webhook Object

Endpoint

POST /v2/businesses/{business}/webhooks

Update a Webhook

Update a webhook for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the webhook for.

webhookstringPath RequiredField must be in path.

The ID of the webhook to retrieve.

Schema undefined not found in OpenAPI spec.

Returns200

The webhook was updated.

The Webhook Object

Endpoint

PATCH /v2/businesses/{business}/webhooks/{webhook}

Delete a Webhook

Delete a webhook for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the webhook for.

webhookstringPath RequiredField must be in path.

The ID of the webhook to retrieve.

Returns204

The webhook was deleted.

Endpoint

DELETE /v2/businesses/{business}/webhooks/{webhook}