CLcloudbeds
Integration Events

Update an integration event.

patch/integration/v1/events/{id}

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/integration/v1/events/{id}
  • Auth
    OAuth 2
    Authorization code: https://api.cloudbeds.com/auth/oauth/authorize
    Token URL: https://api.cloudbeds.com/auth/oauth/token scopes: write:appError

Path parameters

idstring required

Headers

x-property-idstring required
Example:1,2,3

A numeric, comma-separated string representing the property IDs, sent in the header.

Request body

status'open' | 'completed' required

Status of the integration event.

result'failure' | 'success' | 'action_required' | 'warning' nullable

Result of the integration event. When provided, description and details are replaced with the values sent (omitted ones are cleared).

descriptionstring nullable

Description of the integration event. Required when result is failure.

detailsstring nullable

Details of the integration event, that usually contain instructions.

Example request

{
  "status": "open",
  "result": "success",
  "description": "Integration event description",
  "details": "You need to check room mappings."
}

Response

An integration event that was just updated.

idstring required

Unique identifier for the integration event.

propertyIdstring required

Unique identifier for the property.

objectIdstring nullable

Unique identifier for the object associated with the integration event.

objectTypestring required

Type of object associated with the integration event.

systemstring required

Type of system associated with the integration event.

status'open' | 'completed' required

Status of the integration event.

result'failure' | 'success' | 'action_required' | 'warning' required

Result of the integration event.

descriptionstring nullable

Short description of the integration event.

detailsstring nullable

Detailed information about the integration event.

actionTextstring nullable

Text to be displayed for the action associated with the integration event.

createdAtstring Y-m-d\TH:i:sP required
updatedAtstring Y-m-d\TH:i:sP nullable
retriedAtstring Y-m-d\TH:i:sP nullable

Example response

{
  "id": "123456",
  "propertyId": "123456",
  "objectId": "123456",
  "objectType": "reservation",
  "system": "gov",
  "status": "open",
  "result": "success",
  "description": "Integration event description.",
  "details": "Integration event details.",
  "actionText": "Retry",
  "createdAt": "2023-10-01T12:00:00Z",
  "updatedAt": "2023-10-01T12:00:00Z",
  "retriedAt": "2023-10-01T12:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.