Webhook Requests

A webhook request is the actual HTTP POST call we send to your configured endpoint when an event is triggered. Each request includes an event object that describes the event that occurred and a signature to verify the authenticity of the request.

We expect a 2xx response to confirm successful delivery. If your endpoint fails to respond correctly, we will retry the request. Logging and inspection tools are available to help you monitor, debug, and replay webhook requests during development and in production via the Harlyy dashboard.

There are example implementations of webhook handling in various languages available.

The Webhook Request Object

Schema WebhookRequest not found in OpenAPI spec.

Retrieve all Webhook Requests

Retrieve a webhook request for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the webhooks for.

webhookstringPath RequiredField must be in path.

The ID of the webhook to retrieve the requests for.

requeststringPath RequiredField must be in path.

The ID of the webhook request to retrieve.

Returns200

The webhook request was found.

The Webhook Request Object

Endpoint

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

Retrieve a Webhook Request

Retrieve a webhook request for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the webhooks for.

webhookstringPath RequiredField must be in path.

The ID of the webhook to retrieve the requests for.

requeststringPath RequiredField must be in path.

The ID of the webhook request to retrieve.

Returns200

The webhook request was found.

The Webhook Request Object

Endpoint

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

Reattempt a Webhook Request

Attempt to resend a webhook request

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the webhooks for.

webhookstringPath RequiredField must be in path.

The ID of the webhook to retrieve the requests for.

requeststringPath RequiredField must be in path.

The ID of the webhook request to attempt.

Returns200

The webhook request will be reattempted.

The Webhook Request Object

Endpoint

POST /v2/businesses/{business}/webhooks/{webhook}/requests/{request}/reattempt