Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Integration Events

Create a new integration event.

post/integration/v1/events

Headers

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

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

Request body

objectTypestring required

Type of object related to the integration event.

systemstring required

System where the integration event occurred.

status'open' | 'completed' required

Status of the integration event.

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

Result of the integration event.

objectIdstring nullable

ID of object related to the integration event.

descriptionstring nullable

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

detailsstring nullable

Details of the integration event, that usually contain instructions.

actionTextstring nullable

Text to be displayed on the UI for the action.

retryUrlstring nullable

URL that is used to retry the action.

Example request

{
  "objectType": "reservation",
  "system": "gov",
  "status": "open",
  "result": "success",
  "objectId": "1234567890",
  "description": "Integration event description",
  "details": "You need to check room mappings.",
  "actionText": "Retry",
  "retryUrl": "https://example.com/retry"
}

Response

An integration event that was just created.

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