Webhooks

Webhooks provides additional integration possibilities and is a vital part of VAKA Onlines event-driven API design and asynchronous request-response pattern. Webhooks lets VAKA Online push events to your service, to react on when they occur. Types of events can be a result of a previous request or when changes has been made on a particular entity.

One ore more webhooks can be registered on your integration using the Webhook API, to subscribe on the desired event types.

Webhooks is always delivered as a POST request with a JSON payload using the application/json content type. The URL receiving the webhook must use the https scheme (meaning https:// in the beginning of the URL).

Webhook Payload

All webhook events uses the same payload format.

JSON Schema

object
{
    correlationId: string
    eventType: string
    eventData: object
    timestamp: string
}

Example

Attributes

Event Types and Data

The following event types is supported:

• operationResult

• reservationResult

operationResult

Event that signals the completion of an door control action previously requested from the Doors API. See door control error codes for possible error codes.

JSON Schema

object
{
    succeded: boolean
    errorCode: number
    errorDescription: string
    data: object
    {
        doorId: string
    }
}

Example

Attributes

reservationResult

Event that signals the completion of a reservation request or reservation cancellation previously requested from the Reservations API. See reservation error codes for possible error codes.

JSON Schema

object
{
    succeded: boolean
    errorCode: number
    errorDescription: string
    data: object
    {
        reservationId: string
    }
}

Example

Attributes