Webhooks types

Available webhook types to get notified when a reservation is created, updated, or deleted.

🔍 Get webhooks subscriptions

GET/webhooks/subscriptions

Retrieve all webhook subscriptions registered by the client.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Query params

Name	Type	Description
next_cursor	string	Pagination cursor
limit	int	Elements limit per page

Response

{
    "data": [
        {
            "endpoint": "http://localhost:8183/main-page/webhook",
            "id": 9,
            "webhook_type": "RESERVATION_CREATED"
        },
        {
            "endpoint": "http://localhost:8183/main-page/webhook",
            "id": 10,
            "webhook_type": "RESERVATION_UPDATED"
        }
    ]
}

🔍 Get webhooks subscriptions by ID

GET /webhooks/subscription/{id}

Retrieve a specific webhook subscription by its ID.

Response

{
    "data": [
        {
            "endpoint": "http://localhost:8183/main-page/webhook",
            "id": 10,
            "webhook_type": "RESERVATION_UPDATED"
        }
    ]
}

🆕 Create webhook subscription

POST /webhooks/subscription

Registers a new webhook subscription for a specific event type.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
Property	<your_property_id>

Body

Name	Value
endpoint	http://localhost:8183/main-page/webhook
webhook_type	RESERVATION_CREATED

{
    "endpoint": "http://localhost:8183/main-page/webhook",
    "webhook_type": "RESERVATION_CREATED"
}

Response

{
    "data": [
        {
            "endpoint": "http://localhost:8183/main-page/webhook",
            "id": 9,
            "webhook_type": "RESERVATION_CREATED"
        }
    ]
}

🔁 Update webhook subsciption

PUT /webhook/subscription/{id}

Updates the details of an existing webhook subscription.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Value
endpoint	http://localhost:8183/second-page/webhook
webhook_type	RESERVATION_CREATED

Response

{
    "data": [
        {
            "endpoint": "http://localhost:8183/second-page/webhook",
            "id": 9,
            "webhook_type": "RESERVATION_CREATED"
        }
    ]
}

🗑️ Delete webhook subscription

DELETE /webhook/subscription/{id}

Deletes a specific webhook subscription by its ID.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Response

{
    "data": [
        {
            "endpoint": "http://localhost:8183/second-page/webhook",
            "id": 9,
            "webhook_type": "RESERVATION_CREATED"
        }
    ]
}