Docs
Home Blog Memberplace Create Account Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode

API-related

Welcome to the FAQ section dedicated to Upzilla’s API! Here, we address the most common questions related to our public API and its integration with our uptime monitoring service.

How do I access the Upzilla API?

To access the Upzilla API, you need to obtain an API token. You can generate API tokens in the “Integrations / API Access Tokens” section of your Upzilla account dashboard.

What permissions can I assign to API tokens?

When creating or managing API tokens, you have the option to select permissions for each token. These permissions can include read-only access, write-only access, or a combination of both, depending on your requirements.

How do I generate a new API token?

To generate a new API token, navigate to the “Integrations / API Access Tokens” section of your Upzilla account dashboard. From there, you can create a new token and configure its permissions as needed.

Can I manage existing API tokens?

Yes, you can manage existing API tokens from the same “Integrations / API Access Tokens” section. Here, you can view, edit, or revoke existing tokens as necessary.

What is the purpose of webhooks in Upzilla?

Webhooks in Upzilla allow you to receive real-time notifications and updates about monitoring events. You can use webhooks to integrate Upzilla with other applications or services and automate workflows based on monitoring events.

How do I create a new webhook?

To create a new webhook, navigate to the “Webhooks” section of your Upzilla account dashboard. From there, you can specify the URL endpoint where you want to receive webhook notifications and configure any additional settings.

What types of events can trigger webhooks?

Upzilla supports a variety of events that can trigger webhook notifications, including monitor status changes, downtime incidents, and performance alerts. You can customize which events you want to receive notifications for when setting up a webhook.

Can I test my webhook integration before deploying it?

Yes, Upzilla provides a testing feature that allows you to send test payloads to your webhook endpoint to ensure that it is configured correctly and receiving notifications as expected.

Is there a limit to the number of API tokens I can create?

There is no strict limit to the number of API tokens you can create in Upzilla. However, we recommend creating tokens only as needed and managing them responsibly to ensure the security of your account.

Where can I find more information about Upzilla’s API and webhook integration?

For more detailed information about Upzilla’s API and webhook integration, including documentation, usage examples, and best practices, please refer to our official API documentation available on our website or contact our support team for assistance.

We hope this FAQ provides clarity and guidance on integrating Upzilla’s API and utilizing webhooks for seamless integration with your monitoring workflows. If you have any further questions or require assistance, please don’t hesitate to reach out to our support team.