Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Integration Events

Update an integration event.

patch/integration/v1/events/{id}

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.

Example request

{
  "status": "open"
}

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"
}