Events

Events represent significant activities or state changes that occur within a Harlyy Business Account. These can include staff interactions, new submissions from customers, or any other notable actions that are relevant to the business operations.

Each event includes a unique identifier, a timestamp, and a payload containing structured data relevant to the occurrence. Events are the foundation of our webhooks system, allowing you to build real-time integrations that respond to what's happening in your application.

The Event Object

Schema Event not found in OpenAPI spec.

Retrieve all Events

Retrieve events for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the events for.

Returns200

The events.

The Event Object

Endpoint

GET /v2/businesses/{business}/events

Retrieve an Event

Retrieve a event for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the event for.

eventstringPath RequiredField must be in path.

The ID of the event to retrieve.

Returns200

The event was found.

The Event Object

Endpoint

GET /v2/businesses/{business}/events/{event}