uptime-robot-v3
    Preparing search index...

    Client for the Integrations API.

    https://uptimerobot.com/api/v3 Official API Documentation

    1.0.0

    Index

    Integrations

    • Creates a new third-party integration in your UptimeRobot account. Supports various integration types including Slack, Discord, PagerDuty, webhooks, and more. The integration will be active immediately after creation.

      Parameters

      • payload: IntegrationPayload

        Integration configuration object (see IntegrationPayload interface for all options)

      Returns Promise<Integration>

      Promise that resolves to the created Integration object with assigned ID

      When required fields are missing or validation fails

      When conditional requirements are not met (e.g., invalid webhook URL format)

      When API request fails or returns an error response

      // Create a Slack integration
      const slackIntegration = await service.integrations.create({
      name: 'Team Alerts',
      type: 'slack',
      url: 'https://hooks.slack.com/services/...',
      isActive: true
      });

      1.0.0

    • Removes an integration completely from your UptimeRobot account. This action cannot be undone. Any monitors using this integration will no longer send notifications through it.

      Parameters

      • id: idField

        Integration ID (number or string)

      Returns Promise<boolean>

      Promise that resolves to true when deletion is successful

      When integration ID is not found

      When API request fails

      // Delete an integration
      const success = await service.integrations.delete((12345);
      if (success) {
      console.log('Integration deleted successfully');
      }

      1.0.0

    • Fetches complete configuration and status information for an individual integration by ID. Returns all integration properties including type, URL, credentials, and current status.

      Parameters

      • id: idField

        Integration ID (number or string)

      Returns Promise<Integration>

      Promise that resolves to the Integration object

      When integration ID is not found

      When API request fails

      // Get integration details
      const integration = await service.integrations.get(12345);
      console.log(`Integration "${integration.name}" is ${integration.isActive ? 'active' : 'inactive'}`);

      1.0.0

    • Retrieves a list of third-party integrations (Slack, Discord, PagerDuty, etc.) configured in your UptimeRobot account. Results are paginated using cursor-based pagination.

      Parameters

      • Optionalfilter: { cursor?: number }

        Query string parameters passed to the API

        • Optionalcursor?: number

          Pagination cursor for next page

      • OptionalreturnFullResponse: false

      Returns Promise<Integration[]>

      Promise that resolves to an array of Integration objects

      When cursor is negative

      // Get all integrations
      const integrations = await service.integrations.list();

      // Paginate through results
      const page1 = await service.integrations.list();
      const page2 = await service.integrations.list({ cursor: 123456789 });

      // Get full response for pagination
      const response = await service.integrations.list({}, true);
      const nextUrl = new URL(response.nextLink);
      const nextCursorVal = nextUrl.searchParams.get('cursor');
      console.log(nextCursorVal);

      1.0.0

    • Retrieves a list of third-party integrations (Slack, Discord, PagerDuty, etc.) configured in your UptimeRobot account. Results are paginated using cursor-based pagination.

      Parameters

      • filter: { cursor?: number }

        Query string parameters passed to the API

        • Optionalcursor?: number

          Pagination cursor for next page

      • returnFullResponse: true

      Returns Promise<URFullResponse<Integration>>

      Promise that resolves to an array of Integration objects

      When cursor is negative

      // Get all integrations
      const integrations = await service.integrations.list();

      // Paginate through results
      const page1 = await service.integrations.list();
      const page2 = await service.integrations.list({ cursor: 123456789 });

      // Get full response for pagination
      const response = await service.integrations.list({}, true);
      const nextUrl = new URL(response.nextLink);
      const nextCursorVal = nextUrl.searchParams.get('cursor');
      console.log(nextCursorVal);

      1.0.0

    • Modifies the settings of an existing integration. Only provided fields will be updated; omitted fields retain their current values. Changes take effect immediately for future notifications.

      Parameters

      • id: idField

        Integration ID (number or string)

      • payload: IntegrationPayload

        Integration configuration updates (partial IntegrationPayload object)

      Returns Promise<Integration>

      Promise that resolves to the updated Integration object

      When integration ID is not found

      When payload validation fails

      When conditional requirements are not met

      // Update integration name and status
      const updatedIntegration = await service.integrations.update((12345, {
      name: 'Updated Team Alerts',
      isActive: false
      });

      // Update webhook URL
      const webhookUpdate = await service.integrations.update((12345, {
      url: 'https://new-webhook-url.com/endpoint'
      });

      1.0.0

    Other