> ## Documentation Index
> Fetch the complete documentation index at: https://docs.godiligent.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Monitoring

> Create a single monitoring configuration for a customer to receive alerts about website changes and risks.

## Overview

Create a new monitoring configuration for a customer's website. The monitoring will continuously check the specified website for various risk factors and operational status according to the configured frequency.

## Request

* **Method**: `POST`
* **Path**: `/monitorings`
* **Body**: JSON object with monitoring configuration

### Request Body

* `website` (string, required) - The URL to monitor (will be validated and sanitized)
* `checks` (array, required) - Array of monitoring checks to perform:
  * `"non_operational_website"` - Check if website is operational
  * `"high_risk_mcc"` - Check for high-risk MCC
  * `"high_risk_diligent_classification"` - Check for high-risk classification
  * `"catalog_contain_loan_flipping_indicators"` - Check for loan flipping indicators
* `frequency` (string, required, case-insensitive) - How often to run checks:
  * `"weekly"` - Every 7 days
  * `"every_2_weeks"` - Every 14 days (default)
  * `"every_3_weeks"` - Every 21 days
  * `"every_4_weeks"` - Every 28 days
* `expires_at` (ISO8601 string, optional) - When monitoring expires (defaults to 6 months from creation)
  * Must be a future date
  * Must be at least N days ahead where N equals the frequency period
* `run_now` (boolean, optional) - Execute immediately after creation (defaults to true)
* `external_id` (string, optional) - External ID for the monitoring
* `skip_duplicate` (boolean, optional) - If an existing, active monitoring exist with the same site skip don't fail

### Example Request

```json theme={null}
{
  "website": "https://example.com",
  "checks": ["non_operational_website", "high_risk_diligent_classification"],
  "frequency": "weekly",
  "run_now": true,
  "expires_at": "2024-12-31T23:59:59.000Z",
  "external_id": "external_id_123",
  "skip_duplicate":false
}
```

## Success Response

* **Status**: 201 Created

```json theme={null}
{
  "id": "d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4",
  "website": "https://example.com",
  "customer_id": "customer_123",
  "checks": ["non_operational_website", "high_risk_diligent_classification"],
  "frequency": "weekly",
  "expires_at": "2024-12-31T23:59:59.000Z",
  "is_active": true,
  "running_state": "IDLE",
  "next_run_at": "2024-06-10T10:46:00.000Z",
  "last_execution": null,
  "execution_results": [],
  "created_at": "2024-06-03T10:46:00.000Z",
  "updated_at": "2024-06-03T10:46:00.000Z",
  "external_id": "external_id_123"
}
```

## Error Handling

* **400 Bad Request**
  * **Schema validation errors**:
    ```json theme={null}
    { "error": [{"code": "custom", "message": "Invalid check name(s)", "path": ["checks"]}] }
    ```
  * **Monitor already exists**:
    ```json theme={null}
    { "error": "Monitor already exists" }
    ```
  * **URL validation failed**:
    ```json theme={null}
    { "error": [{"code": "custom", "message": "URL is disallowed or invalid", "path": ["website"]}] }
    ```
* **401 Unauthorized**
  * Missing or invalid customer authentication
* **500 Internal Server Error**
  * Unexpected server error during creation or execution

## Validation Rules

* **Website URL**: Must be a valid, allowed URL that passes security validation
* **Unique Checks**: Each monitoring must have unique check names (no duplicates)
* **Frequency**: Case-insensitive input, normalized to lowercase
* **Expiration Date**: Must be future date, at least N days ahead based on frequency
* **Duplicate Prevention**: Cannot create monitoring for website that already exists for this customer

## Notes

* If `run_now` is true, the monitoring will be queued for immediate execution via SQS
* Frequency input is case-insensitive and normalized to lowercase
* All URLs are validated and sanitized for security before storage
* Default expiration is 6 months from creation if not specified


## OpenAPI

````yaml POST /monitorings
openapi: 3.0.1
info:
  version: 1.5.0
  title: Diligent
  description: >
    Download Postman collection
    [here](https://docs.godiligent.ai/files/postman_collection.json).
servers:
  - url: https://api.godiligent.ai
    description: Production
  - url: https://api.sandbox.godiligent.ai
    description: Sandbox
security:
  - xApiKey: []
tags:
  - name: CDD
    description: Customer Due Diligence
  - name: Company
    description: Company Information
  - name: Blocked Companies
    description: Manage blocked companies
  - name: Monitorings
    description: Website monitoring and alerts for changes and risks
  - name: Webhooks
    description: >

      ## How to Secure Webhook Deliveries

      To ensure that webhook payloads are securely transmitted and verified.
      This guide explains how to configure and validate

      webhook deliveries using a shared secret.


      ### How It Works


      When setting up a webhook, a secret is configured on both the sender (our
      system) and the receiver (your endpoint). Each

      webhook payload is signed using this secret, allowing the receiver to
      verify its authenticity.


      #### Step 1: Configuring Your Webhook Secret


      1. When creating a webhook in our system, specify a unique secret key.
      This secret should be a strong, randomly

      generated string.

      2. Store this secret securely on your server; it should never be exposed
      publicly.


      #### Step 2: Receiving Webhook Payloads


      When your server receives a webhook event, the request will include an
      `X-Signature` header containing a HMAC signature

      of the payload.


      Example header:


      ```

      X-Signature: sha256=abcdef1234567890...

      ```


      #### Step 3: Validating the Webhook Signature


      To verify the webhook payload:


      1. Retrieve the `X-Signature` value from the request headers.

      2. Compute the HMAC SHA-256 signature of the request payload using your
      webhook secret.

      3. Compare the computed signature with the one in the `X-Signature`
      header.

      4. If they match, the webhook is valid.


      #### (Python)


      ```python

      import hashlib

      import hmac

      import json


      def verify_webhook_signature(secret, payload, signature):
        computed_signature = hmac.new(secret.encode(), payload.encode(), hashlib.sha256).hexdigest()
        expected_signature = f"sha256={computed_signature}"
        return hmac.compare_digest(expected_signature, signature)

      # Example usage:

      secret = "your_webhook_secret"

      payload = json.dumps({"event": "example"})

      received_signature = "sha256=abcdef1234567890..."


      if verify_webhook_signature(secret, payload, received_signature):
        print("Valid webhook received!")
      else:
        print("Invalid webhook signature!")
      ```


      #### (JavaScript)


      ```javascript

      const crypto = require('crypto');


      function verifyWebhookSignature (secret, payload, signature) {

      const computedSignature = `sha256=${crypto.createHmac('sha256', secret)

      .update(payload)

      .digest('hex')}`;

      return crypto.timingSafeEqual(Buffer.from(computedSignature),
      Buffer.from(signature));

      }


      // Example usage:

      const secret = "your_webhook_secret";

      const payload = JSON.stringify({ event: "example" });

      const receivedSignature = "sha256=abcdef1234567890...";


      if (verifyWebhookSignature(secret, payload, receivedSignature)) {

      console.log("Valid webhook received!");

      } else {

      console.log("Invalid webhook signature!");

      }

      ```


      #### Security Considerations


      - Always use HTTPS to prevent interception of webhook payloads.

      - Reject webhook requests that fail signature validation.

      - Rotate secrets periodically to enhance security.


      By following this guide, you ensure that webhook deliveries are secure and
      trusted.
  - name: Instant Screening (experimental)
    description: Instant Website Screening API
  - name: Name Screening
    description: Name screening search, alert management and remediation
paths:
  /monitorings:
    post:
      tags:
        - Monitorings
      summary: Create a new monitoring
      description: Create a new monitoring for a customer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MonitoringRequest'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Monitoring'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      security:
        - xApiKey: []
components:
  schemas:
    MonitoringRequest:
      type: object
      required:
        - website
        - checks
        - frequency
      properties:
        website:
          type: string
          format: uri
          description: The website URL to monitor
          example: https://example.com
        checks:
          type: array
          minItems: 1
          uniqueItems: true
          items:
            type: string
            enum:
              - non_operational_website
              - high_risk_mcc
              - high_risk_diligent_classification
              - catalog_contain_loan_flipping_indicators
          description: Array of monitoring checks to perform
          example:
            - non_operational_website
            - high_risk_diligent_classification
        frequency:
          type: string
          enum:
            - weekly
            - every_2_weeks
            - every_3_weeks
            - every_4_weeks
          default: every_2_weeks
          description: How often to run the monitoring checks
          example: weekly
        run_now:
          type: boolean
          default: true
          description: Whether to execute the monitoring immediately after creation
        expires_at:
          type: string
          format: date-time
          description: >-
            Optional expiration date for the monitoring (defaults to 6 months
            from creation)
          example: '2024-12-31T23:59:59.000Z'
        skip_duplicate:
          type: boolean
          description: >-
            If an existing, active monitoring exist with the same site skip
            don't fail
          example: false
    Monitoring:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique monitoring identifier
          example: d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4
        website:
          type: string
          format: uri
          description: The monitored website URL
          example: https://example.com
        customer_id:
          type: string
          description: Customer identifier
        checks:
          type: array
          items:
            type: string
            enum:
              - non_operational_website
              - high_risk_diligent_classification
              - catalog_contain_loan_flipping_indicators
          description: Active monitoring checks
        frequency:
          type: string
          enum:
            - weekly
            - every_2_weeks
            - every_3_weeks
            - every_4_weeks
          description: Monitoring frequency
        is_active:
          type: boolean
          description: Whether monitoring is active
        running_state:
          type: string
          enum:
            - IDLE
            - RUNNING
            - FAILED
          description: Current execution state
        next_run_at:
          type: string
          format: date-time
          description: Next scheduled execution time
        expires_at:
          type: string
          format: date-time
          description: Monitoring expiration date
        last_execution:
          type: string
          format: date-time
          nullable: true
          description: Timestamp of last execution, null if never executed
        created_at:
          type: string
          format: date-time
          description: Creation timestamp
        updated_at:
          type: string
          format: date-time
          description: Last update timestamp
        execution_results:
          type: array
          items:
            type: object
          description: Results from the latest monitoring execution
        external_id:
          type: string
          description: External identifier for this monitoring
    ValidationError:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorItem'
      required:
        - errors
    ValidationErrorItem:
      type: object
      properties:
        path:
          type: array
          items:
            type: string
          description: JSON path to the field with the error
        message:
          type: string
          description: Error message
        code:
          type: string
          description: Error code indicating the type of error
      required:
        - path
        - message
        - code
  securitySchemes:
    xApiKey:
      type: apiKey
      name: X-API-KEY
      in: header

````