Guesty's Open API is a REST API offers a versatile solution for integrating your own systems with your Guesty account. It uses OAuth 2.0 access tokens to authenticate requests, ensuring secure and reliable authorization. OAuth 2.0 is a secure, industry-standard authorization method that ensures user data is accessed safely using encoded tokens without exposing the user’s identity or credentials. For more information, refer to our API documentation and details on Guesty’s API call rate limits.
Guesty's Open API allows you and your team to build and connect custom tools tailored to your needs. You can generate unique client IDs and client secrets (client credentials) for each service, tool, or system you integrate. Additionally, our analytics provide real time data on your API usage, helping you monitor and optimize your integrations.
Follow the instructions below to register a new application. You can delete it at any time.
Create API key pair
When you register an application, you will receive a client ID and a client secret, which can be used when making API calls that require application identification.
Step by step:
- Sign in to your Guesty account.
-
In the top-right click
and select Open API. - In the left menu, click Applications (this should already be selected by default).
- At the top right, click New application.
- Enter the application name and description and click Save. These are mandatory fields.
- Click
next to the relevant key and paste it somewhere safe for future reference.
Important:
Your client ID and client secret are only visible the first time you access it, after which Guesty redacts it for your security.
Delete API key pair
To delete an application, along with its client ID and client secret, click 
to the right of the relevant application and confirm the action in the pop-up. This action is irreversible.
Using Guesty's Open API analytics dashboard
Guesty's Open API analytics dashboard is designed to provide a detailed overview of your application's API usage and performance. This tool allows you to monitor key metrics such as request success rates, client errors, and rate limit thresholds. Each section of the dashboard offers valuable insights, helping you optimize API calls, troubleshoot issues, and ensure smooth integration with third-party applications.
Follow the instructions to access Guesty's Open API dashboard.
Step by step:
- Sign in to your Guesty account.
-
In the top-right click
and select Open API. - In the left menu, click Analytics.
Learn more about the dashboard's sections below.
Filters
Click the plus sign to apply the following filters to the entire dashboard:
- Time frame
- Response status
- Response resolution
- URL family
- URL template
- Host
- Method
- Client ID
- Client name
- Gateway proceed
- Server type
Tip:
To filter by endpoint, click the relevant endpoint in the URL template table.
General requests
Use the general requests graph to view the following Open API calls for all applications:
- Success calls
- Failed calls due to client error
- Failed calls due to server error
Rate limit
Use the rate limit graph to view the remaining amount of rate limits for each application as follows:
- Remaining calls per hour until rate limit
- Remaining calls per minute until rate limit
- Remaining calls per second until rate limit
URL Template
The table displays the following in descending order:
- URL template - the endpoint that was called
- Number of events - the number of calls made
Client requests
Refer to the colored lines on the graph to identify the Open API calls for each application under your account.
Using Guesty's client-facing webhooks
Guesty's dedicated webhooks section provides a centralized interface to manage webhooks, view activity, and troubleshoot issues effectively. Refer to Guesty's official webhooks documentation for more information.
Endpoints
Regularly monitor endpoints to ensure low error rates and resolve any issues promptly. View and manage all active webhook URLs and their respective error rates. The error rate reflects the success of webhook deliveries:
- 0% indicates all webhooks are successfully delivered.
- An error rate on an active URL indicates delivery issues that may need troubleshooting.
View logs for a specific URL
Use webhook logs for a specific URL endpoint to isolate issues related to the endpoint.
Endpoint URL webhooks activity page
Click a webhook URL to access detailed information, which includes the following:
-
Overview
- Creation date
- Last update date
- Subscribed events
- Signing secret
The key used to authenticate requests from Guesty to your endpoint.
- Replay events
To replay individual webhook events, click
next to the relevant event, select the relevant action in the pop-up and click Resend. - Filters
Use filters to narrow down results:
Filter by All, Succeeded, or Failed or click Filters to filter by Event types, Tags, or Dates
- Logs
Click the relevant event type to view the payload of a specific URL.
- Advanced: Presently for viewing purposes only.
- Testing: Presently for viewing purposes only.
Event catalog
Displays a list of all Guesty's event types. Click the event type to view the schema.
Logs
Use logs for a broad view of all webhook activities to spot trends or potential system-wide issues, ideal for identifying patterns or reviewing recent activity regardless of the endpoint.
You can view logs for a specific URL endpoint to isolate issues related to the endpoint.
Alternatively, click an event type to view the payload of a specific URL to view all message logs across subscribed endpoints. This is useful to diagnose a broader issue for multiple endpoints.
You can also filter for event types, or click Jump to message, enter a message/event ID and click Go to locate a specific event.
Activity
Displays a visual representation of webhook performance over the last six hours, to gain real-time insights into your webhook performance and take proactive measures as needed.
View the number of successful and failed webhook delivery attempts to quickly identify any spikes in failures or other anomalies.
