Lodgify

Learn how to use Lodgify with Composio

Overview

SLUG: LODGIFY

Description

Lodgify is an all-in-one vacation rental software that enables property owners and managers to create bookable websites, synchronize property data across multiple channels, and manage guest reservations and communications from a single platform.

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
string
bearer_token
string
generic_api_key
stringRequired

Connecting to Lodgify

Create an auth config

Use the dashboard to create an auth config for the Lodgify toolkit. This allows you to connect multiple Lodgify accounts to Composio for agents to use.

1

Select App

Navigate to the Lodgify toolkit page and click “Setup Integration”.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Integration”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2from composio.types import auth_scheme
3
4# Replace these with your actual values
5lodgify_auth_config_id = "ac_YOUR_LODGIFY_CONFIG_ID" # Auth config ID created above
6user_id = "0000-0000-0000" # UUID from database/application
7
8composio = Composio()
9
10
11def authenticate_toolkit(user_id: str, auth_config_id: str):
12 connection_request = composio.connected_accounts.initiate(
13 user_id=user_id,
14 auth_config_id=auth_config_id,
15 )
16
17 print(
18 f"Visit this URL to authenticate Lodgify: {connection_request.redirect_url}"
19 )
20
21 # This will wait for the auth flow to be completed
22 connection_request.wait_for_connection(timeout=15)
23 return connection_request.id
24
25
26connection_id = authenticate_toolkit(user_id, lodgify_auth_config_id)
27
28# You can also verify the connection status using:
29connected_account = composio.connected_accounts.get(connection_id)
30print(f"Connected account: {connected_account}")

Using API Key

1from composio import Composio
2from composio.types import auth_scheme
3
4# Replace these with your actual values
5lodgify_auth_config_id = "ac_YOUR_LODGIFY_CONFIG_ID" # Auth config ID created above
6user_id = "0000-0000-0000" # UUID from database/app
7
8composio = Composio()
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 # Replace this with a method to retrieve an API key from the user.
12 # Or supply your own.
13 user_api_key = input("[!] Enter API key")
14
15 connection_request = composio.connected_accounts.initiate(
16 user_id=user_id,
17 auth_config_id=auth_config_id,
18 config={"auth_scheme": "API_KEY", "val": user_api_key}
19 )
20
21 # API Key authentication is immediate - no redirect needed
22 print(f"Successfully connected Lodgify for user {user_id}")
23 print(f"Connection status: {connection_request.status}")
24
25 return connection_request.id
26
27
28connection_id = authenticate_toolkit(user_id, lodgify_auth_config_id)
29
30# You can verify the connection using:
31connected_account = composio.connected_accounts.get(connection_id)
32print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Lodgify toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["LODGIFY"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Get Property Availability

Description

This tool retrieves the availability information for a specific property. it requires the propertyid as an input. the response will include an array of availability objects, each containing the date, availability status, number of units available, price (amount and currency), minimum and maximum nights for booking, and any associated reservation ids for that date.

Action Parameters

propertyId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Countries

Description

Tool to retrieve all available countries. use when you need to populate country selectors with supported iso codes and names.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Channels

Description

Tool to retrieve a list of all channels. use when you need to view or process all channel configurations.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Channel Connections

Description

Tool to retrieve a list of all channel connections. use when you need to display or synchronize channel connections across properties.

Action Parameters

channel
string
page
integer
pageSize
integer
status
string

Action Response

data
arrayRequired
error
string
page
integerRequired
pageSize
integerRequired
successful
booleanRequired
total
integerRequired

Tool Name: List Channel Mappings

Description

Tool to list channel mappings. use when you need to retrieve all channel mappings, optionally filtered by property, channel code, or external id. supports pagination.

Action Parameters

channelCode
string
externalId
string
page
integer
pageSize
integer
propertyId
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Channel Reservations

Description

Tool to list channel reservations. use when you need to retrieve reservations across channels filtered by property, channel, or date range.

Action Parameters

channelId
integer
createdFrom
string
createdTo
string
limit
integer
offset
integer
propertyId
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Properties

Description

Tool to retrieve a paginated list of properties. use when you need to view or process all properties with pagination.

Action Parameters

page
integer
pageSize
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired