---
title: "Create a new integration event."
method: POST
path: "/integration/v1/events"
tags: ["Integration Events"]
---

# Create a new integration event.

`POST /integration/v1/events`

## Request

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

## Headers

- `x-property-id` string, required

## Request body

- IntegrationEventCreateRequestSchema
  - `objectType` string, required: Type of object related to the integration event.
  - `system` string, 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.
  - `objectId` string, nullable: ID of object related to the integration event.
  - `description` string, nullable: Description of the integration event. Required when result is failure.
  - `details` string, nullable: Details of the integration event, that usually contain instructions.
  - `actionText` string, nullable: Text to be displayed on the UI for the action.
  - `retryUrl` string, nullable: URL that is used to retry the action.

## Response `201`

An integration event that was just created.

- IntegrationEventResponseSchema
  - `id` string, required: Unique identifier for the integration event.
  - `propertyId` string, required: Unique identifier for the property.
  - `objectId` string, nullable: Unique identifier for the object associated with the integration event.
  - `objectType` string, required: Type of object associated with the integration event.
  - `system` string, 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.
  - `description` string, nullable: Short description of the integration event.
  - `details` string, nullable: Detailed information about the integration event.
  - `actionText` string, nullable: Text to be displayed for the action associated with the integration event.
  - `createdAt` string, Y-m-d\TH:i:sP, required
  - `updatedAt` string, Y-m-d\TH:i:sP, nullable
  - `retriedAt` string, Y-m-d\TH:i:sP, nullable

## Other responses

- `400`: Bad Request response
- `401`: Unauthorized response
- `500`: Internal server error

---

[API](https://skmtc.dev/cloudbeds/apis/cloudbeds-api-v2.md) - [All operations](https://skmtc.dev/cloudbeds/apis/cloudbeds-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudbeds/apis/cloudbeds-api-v2/revisions/69bffac143cc?raw)
