Webhooks: Overview

⚠️Important

Caspeco currently supports Snapshot Webhooks only.
Classic Webhooks are not available in this release.

Our Implementation of Webhooks

Caspeco Cloud provides webhooks for transmitting real-time updates of employee and booking actions. The webhooks use HTTPS for the transmission of events in Caspeco Cloud to one or more receiving endpoints in the form of JSON messages.

If you’d instead get an employees state before and after an event - this can be configured, see Snapshot Webhooks.

The employee-related events differ slightly from the more “traditional” implementation pattern of webhooks as the Caspeco system allows users to create future changes or “change points” on an employment. The future change points are put in a message queue awaiting transmission. Once the scheduled change points take effect, the queued webhook messages are sent in the same manner as the real-time event messages. See more information on how the employee webhook events are triggered.

Creating and Configuring Webhooks in Caspeco Cloud

Your webhook events and receiving end-points must be registered in Caspeco Cloud. The Caspeco webhooks expect a public HTTPS endpoint to be registered on the webhook page in Caspeco Cloud. Your endpoint(s) must be configured for parsing the JSON payloads of the event messages sent via POST requests to your endpoint(s). Upon message received, a 200 (OK)-status message is expected to be returned from the receiving endpoint. See more information on how to configure your webhook events in Caspeco Cloud

Securing your Webhooks (Recommended)

Caspeco webhooks allow you to create a signature to help you verify that the webhook messages are coming from Caspeco and not some other server acting like Caspeco.
See more information on how to create and use a signature