Realm9 Logo
Search documentation...

Integrations

Realm9 integrates with popular development and operations tools to fit seamlessly into your existing workflows.

ServiceNow Integration

Overview

Realm9's ServiceNow integration provides comprehensive CMDB (Configuration Management Database) connectivity and environment request automation.

Setup Instructions

1. Configure ServiceNow Integration

Navigate to Integrations in the admin panel and set up ServiceNow:

Required Fields:

  • Instance URL: Your ServiceNow instance URL (e.g., https://your-company.service-now.com)
  • API Token: ServiceNow API key with appropriate permissions
  • Integration Name: Descriptive name for this integration

2. Required ServiceNow Permissions

Your ServiceNow API token needs access to:

  • sc_request table (Service Requests)
  • sys_db_object table (CMDB Class definitions)
  • sys_dictionary table (Field definitions)
  • CI tables (e.g., cmdb_ci_server, cmdb_ci_application)

3. Test Connection

After configuration, use the "Test Connection" feature to verify:

  • ServiceNow instance accessibility
  • API token validity
  • Required table permissions

Features

CMDB Integration:

  • Browse ServiceNow CI (Configuration Item) classes
  • Explore hierarchical CI class structures
  • Import CI data during environment creation
  • View imported ServiceNow data on environment details

Environment Request Automation:

  • Automatically create ServiceNow service requests for environment access
  • Configure request categories, priorities, and assignment groups
  • Track request status and approvals
  • Link environment bookings to ServiceNow tickets

CMDB Data Import

During Environment Creation

When creating environments, you can optionally import ServiceNow CI data:

  1. Select CI Class: Browse available ServiceNow CI classes (servers, applications, etc.)
  2. Choose Records: Select specific CI records to associate with your environment
  3. Import Data: CI data is stored with the environment for reference

Viewing CMDB Data

Imported ServiceNow data appears on the environment details page, showing:

  • CI class information
  • Record details and attributes
  • Direct links to ServiceNow records

Environment Request Automation

Automatic Ticket Creation

When configured, Realm9 can automatically create ServiceNow service requests for:

  • Environment access requests
  • Booking approvals
  • Change management workflows

REST API

General API Access

Realm9 provides a comprehensive REST API for programmatic access:

Features:

  • Complete CRUD operations for environments and bookings
  • Filtering and pagination support
  • Rate limiting and authentication
  • OpenAPI/Swagger documentation

Authentication:

  • API key-based authentication
  • Session-based authentication for UI
  • Role-based access control

Documentation: See API Reference for detailed endpoint documentation.

Webhooks

Custom Webhook Integration

Create custom integrations with external systems:

Setup:

  1. Navigate to Integrations > Webhooks
  2. Configure endpoint URL and authentication
  3. Select events to monitor
  4. Test webhook delivery

Supported Events:

  • environment.created
  • environment.updated
  • booking.approved
  • booking.completed

Example Payload:

{
  "event": "environment.created",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "id": "env_123",
    "name": "prod-api",
    "type": "PRODUCTION"
  }
}

Security Best Practices

Integration Security

  • Use separate credentials per integration
  • Rotate tokens and credentials regularly
  • Enable comprehensive audit logging
  • Limit integration permissions to minimum required
  • Encrypt sensitive integration data

Monitoring and Alerting

  • Monitor integration health and availability
  • Set up alerts for authentication failures
  • Track API rate limit usage
  • Log all integration activities
  • Review integration logs regularly

Next Steps