Skip to main content
POST
/
api
/
v1
/
outgoing-webhooks
/
{provider}
Create outgoing webhook app
curl --request POST \
  --url https://api.example.com/api/v1/outgoing-webhooks/{provider} \
  --header 'Content-Type: application/json' \
  --header 'x-calry-api-key: <api-key>' \
  --data '
{
  "events": [
    "RESERVATION_CREATED",
    "RESERVATION_UPDATED"
  ],
  "urls": [
    "https://example.com/webhook",
    "https://api.example.com/notifications"
  ]
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "provider": "HOSTAWAY",
  "workspaceID": "123e4567-e89b-12d3-a456-426614174000",
  "events": [
    "RESERVATION_CREATED",
    "RESERVATION_UPDATED",
    "LISTINGS_IMPORTED"
  ],
  "urls": [
    "https://example.com/webhook",
    "https://api.example.com/notifications"
  ],
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-02T00:00:00.000Z"
}

Authorizations

​
x-calry-api-key
string
header
required

Headers

​
x-calry-tenant-id
string

Optional tenant ID to specify which tenant to operate as. If not provided, the default tenant will be used.

Path Parameters

​
provider
enum<string>
required

Integration provider to create webhook for

Available options:
BOOKINGSYNC,
GUESTY,
HOSTAWAY,
HOSTFULLY,
HOSTIFY,
INTERHOME,
LODGIFY,
OWNERREZ,
HOSTHUB,
UPLISTING,
BEDS24,
HOST_TOOLS,
HOSTFULLYSANDBOX,
HOSPITABLE,
TOKEET

Body

application/json
​
events
enum<string>[]
required

List of events that will trigger this webhook app

Available options:
RESERVATION_CREATED,
RESERVATION_UPDATED,
RESERVATION_CANCELLED,
NEW_LISTINGS_IMPORTED
Example:
[
  "RESERVATION_CREATED",
  "RESERVATION_UPDATED"
]
​
urls
string[]
required

List of URLs that will receive webhook notifications

Example:
[
  "https://example.com/webhook",
  "https://api.example.com/notifications"
]

Response

Webhook app created successfully

​
id
string
required

Unique identifier of the webhook app

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
provider
enum<string>
required

Integration provider this webhook app is configured for

Available options:
BOOKINGSYNC,
GUESTY,
HOSTAWAY,
HOSTFULLY,
HOSTIFY,
INTERHOME,
LODGIFY,
OWNERREZ,
HOSTHUB,
UPLISTING,
BEDS24,
HOST_TOOLS,
HOSTFULLYSANDBOX,
HOSPITABLE,
TOKEET
Example:

"HOSTAWAY"

​
workspaceID
string
required

ID of the workspace this webhook app belongs to

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
events
enum<string>[]
required

List of events that will trigger this webhook app

Available options:
RESERVATION_CREATED,
RESERVATION_UPDATED,
RESERVATION_CANCELLED,
NEW_LISTINGS_IMPORTED
Example:
[
  "RESERVATION_CREATED",
  "RESERVATION_UPDATED",
  "LISTINGS_IMPORTED"
]
​
urls
string[]
required

List of URLs that will receive webhook notifications

Example:
[
  "https://example.com/webhook",
  "https://api.example.com/notifications"
]
​
createdAt
string<date-time>
required

Timestamp when the webhook app was created

Example:

"2024-01-01T00:00:00.000Z"

​
updatedAt
string<date-time>
required

Timestamp when the webhook app was last updated

Example:

"2024-01-02T00:00:00.000Z"