WHERE DO I START?
You are here:... (Miscellaneous) > Notifications > VictorOps

VictorOps

Add a VictorOps notification

Configuring Netuitive to receive VictorOps data and events is a two-step process:

  1. Copy the REST API URL for inbound webhooks in your VictorOps account
  2. Create a Webhook notification in Netuitive using the URL from VictorOps

Step 1: Copy the REST API URL for inbound webhooks in your VictorOps account

  1. Login to your VictorOps account.
  2. Click on the Settings button in the top left corner.

  3. Click the Integrations button.

  4. Scroll down to find the REST Endpoint link.
    Note   The Webhooks link at the bottom of the page is for outbound messages; we need to enable inbound messages.
  5. Click the REST Endpoint link. A Post URL will be generated on the page.
  6. Create a routing key at the bottom of the page.
  7. Copy the Post URL. You will use this URL in Step 2.

Step 2: Create a Webhook notification in Netuitive using the URL from VictorOps

  1. Ensure you've created a blank Webhook notification in Netuitive.
  2. Type a name for the webhook notification.
  3. Ensure the Enabled checkbox is selected.
  4. For URL, paste the URL you copied in step 1.g.
  5. If the URL you provided requires basic authentication, type the username and password.
  6. Optionally, add one or more headers (key-value pairs) to the webhook notification.
  7. Optionally, select Custom from the Payload drop-down menu. A text field will open after selecting Custom. You can use the following variables and/or VictorOps fields to make your notification more dynamic. To test your template, go here or visit the GitHub page.
    • VictorOps fields (visit the VictorOps knowledge base for more information):
      Field NameDescription
      message_type

      String value. This field allows the following values: INFO, WARNING, ACKNOWLEDGMENT, CRITICAL, RECOVERY.

      Important   This field is required.
      entity_is_hostString value. Whether the alerting entity is the host.
      entity_idString value. The name of the alerting entity.
      timestampNumber value. Timestamp of the alert in seconds since epoch.
      state_start_timeNumber value. The time the entity entered its current state (in seconds since epoch).
      state_messageString value. Any additional status information from the alert.
      monitoring_toolString value. The name of the monitoring system software/application.
      entity_display_nameString value. Name used in VictorOps to display a human-readable name for the entity.
      ack_msgString value. User-entered comment for acknowledgment.
      ack_authorString value. The name of the user that acknowledged the incident.
      Example(s)   The following is an example custom JSON payload using only VictorOps fields.
      {
        "message_type":"INFO",
        "entity_is_host":"Yes",
        "entity_id":"Netuitive Test",
        "state_message":"host is up"
      }

      Here's what the custom payload looks like in VictorOps:

    • Variables:
      VariableDescription
      ${eventCategory.name}

      The event category ( (Info), (Warning), or (Critical)).

      ${elementFqn}The Fully Qualified Name (FQN) of the element.
      ${elementId}The type of element (e.g., SERVER, ELB, EC2, RDS, etc.).
      ${elementLocation}The location of the element.
      ${elementName}The friendly name for the element.
      ${policyId}The policy identification number.
      ${policyName}The name of the policy.
      ${eventTimestamp}The time (in UTC) the event occurred.
      ${policyDescription}The description of the policy that generated the event.
    • Example(s)   The following is an example custom JSON payload using a combination of VictorOps fields and variables.
      {
        "message_type":"INFO",
        "entity_is_host":"Yes",
        "entity_id":"${elementId}",
        "state_message":"${elementName} is up, but an event occurred at ${eventTimestamp}."
      }

      Here's what the custom payload looks like in VictorOps:

  8. Click Test to test the webhook.
    Important   The endpoint URL must return an HTTP code 200 to pass the validation.
  9. Click Save.