BigPanda · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BigPanda Alert Ingestion (OIM) Alert Ingestion (OIM) Alert…… Alert Ingestion (OIM) API

27 actions 27 updates phrasing extends openapi/bigpanda-alert-ingestion-oim-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for BigPanda's API. It is a proposal applied on top of the contract, not a document BigPanda publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 27 · first 16 shown; the file carries all of them

$.info
$.paths['/oim/{integration}/alerts'].post
$.paths['/oim/appdynamicsapi_v3/alerts'].post
$.paths['/oim/azure_monitor_v2/alerts'].post
$.paths['/oim/meraki/alerts'].post
$.paths['/oim/cloudwatch/alerts'].post
$.paths['/oim/cribl/alerts'].post
$.paths['/oim/datadog_v2/alerts'].post
$.paths['/oim/dynatrace_v2/alerts'].post
$.paths['/oim/entuity/alerts'].post
$.paths['/oim/logscale/alerts'].post
$.paths['/oim/logicmonitor/alerts'].post
$.paths['/oim/nagios/alerts'].post
$.paths['/oim/newrelic/alerts'].post
$.paths['/oim/prometheus/alerts'].post
$.paths['/oim/scom_v2/alerts'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for BigPanda Alert Ingestion (OIM) Alert Ingestion (OIM) Alert…… Alert Ingestion (OIM) API
  version: 1.0.0
extends: openapi/bigpanda-alert-ingestion-oim-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 26
- target: $.paths['/oim/{integration}/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an alert to a named OIM integration
      effect: write
      questions:
      - How do I push an alert payload into BigPanda for a specific OIM integration by its name in the URL?
      - Is there a generic ingestion route where the integration name is a path segment rather than a fixed tool?
      instructions:
      - text: Post this alert payload to the {integration} OIM integration for normalization.
        slots:
          integration: path.integration
      - text: Ingest an alert through the generic OIM route for integration {integration}.
        slots:
          integration: path.integration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/appdynamicsapi_v3/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an AppDynamics alert through OIM
      effect: write
      questions:
      - What does a well-formed AppDynamics health rule violation look like when sent to OIM?
      - Can I test my AppDynamics integration end to end with a sample policy alert before going live?
      instructions:
      - text: Send an AppDynamics alert for policy {policy_name} to integration app key {app_key}.
        slots:
          policy_name: requestBody.policy_name
          app_key: query.app_key
      - text: Post a sample AppDynamics action {action_name} from controller account {account_name}.
        slots:
          action_name: requestBody.action_name
          account_name: requestBody.account_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/azure_monitor_v2/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an Azure Monitor alert through OIM
      effect: write
      questions:
      - What payload shape does BigPanda expect from an Azure Monitor common alert schema?
      - Can I validate my Azure Monitor integration with a test alert before routing production traffic?
      instructions:
      - text: Send an Azure Monitor alert with schema {schemaId} to app key {app_key}.
        slots:
          schemaId: requestBody.schemaId
          app_key: query.app_key
      - text: Post a sample Azure Monitor alert payload to my test integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/meraki/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a Cisco Meraki alert through OIM
      effect: write
      questions:
      - What fields does a Cisco Meraki network alert need when forwarded to BigPanda?
      - Can I send a sample Meraki device alert to check my integration pipeline works?
      instructions:
      - text: Send a Meraki {alertType} alert for device {deviceName} on network {networkName}.
        slots:
          alertType: requestBody.alertType
          deviceName: requestBody.deviceName
          networkName: requestBody.networkName
      - text: Post a Cisco Meraki alert at level {alertLevel} to app key {app_key}.
        slots:
          alertLevel: requestBody.alertLevel
          app_key: query.app_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/cloudwatch/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an Amazon CloudWatch alert through OIM
      effect: write
      questions:
      - What does an Amazon CloudWatch alert payload look like for BigPanda's CloudWatch integration?
      - Can I fire a test CloudWatch alarm into my integration before connecting real accounts?
      instructions:
      - text: Send a CloudWatch alert {alertName} for resource {resourceName} with criticality {criticality}.
        slots:
          alertName: requestBody.alertName
          resourceName: requestBody.resourceName
          criticality: requestBody.criticality
      - text: Post a sample CloudWatch alarm to integration app key {app_key}.
        slots:
          app_key: query.app_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/cribl/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a Cribl alert through OIM
      effect: write
      questions:
      - Can Cribl forward alerts into BigPanda through an existing Cribl integration?
      - Which authentication does the Cribl alert route need, an app key and access token?
      instructions:
      - text: Forward a Cribl alert to the Cribl integration with app key {app_key}.
        slots:
          app_key: query.app_key
      - text: Send a test Cribl event into my Cribl integration pipeline.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/datadog_v2/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a Datadog monitor alert through OIM
      effect: write
      questions:
      - What does a Datadog monitor alert look like when it's sent to BigPanda?
      - Can I include the alert query, host and cluster name from a Datadog monitor in the payload?
      instructions:
      - text: Send a Datadog alert titled {title} for host {host} with status {alert_status}.
        slots:
          title: requestBody.title
          host: requestBody.host
          alert_status: requestBody.alert_status
      - text: Post a Datadog monitor alert on metric {alert_metric} to app key {app_key}.
        slots:
          alert_metric: requestBody.alert_metric
          app_key: query.app_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/dynatrace_v2/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a Dynatrace problem alert through OIM
      effect: write
      questions:
      - How are Dynatrace problem notifications formatted for BigPanda ingestion?
      - Can I send a Dynatrace problem with its impacted entity and state as a test?
      instructions:
      - text: Send Dynatrace problem {ProblemID} titled {ProblemTitle} with state {State}.
        slots:
          ProblemID: requestBody.ProblemID
          ProblemTitle: requestBody.ProblemTitle
          State: requestBody.State
      - text: Post a Dynatrace problem affecting {ImpactedEntity} to my test integration.
        slots:
          ImpactedEntity: requestBody.ImpactedEntity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/entuity/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an Entuity incident through OIM
      effect: write
      questions:
      - What does an Entuity network incident payload look like for BigPanda?
      - Can I send an Entuity incident with its severity and source host as a pipeline test?
      instructions:
      - text: Send Entuity incident {incident_name} with severity {incident_severity}.
        slots:
          incident_name: requestBody.incident_name
          incident_severity: requestBody.incident_severity
      - text: Post a sample Entuity incident to integration app key {app_key}.
        slots:
          app_key: query.app_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/logscale/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Ingest a Falcon LogScale alert
      effect: write
      questions:
      - How do I get alerts from Falcon LogScale (formerly Humio) into BigPanda?
      - Which host does the LogScale alert endpoint live on, integrations or api?
      instructions:
      - text: Ingest LogScale alert {alert} from repository {repository} with {numberOfEvents} events.
        slots:
          alert: requestBody.alert
          repository: requestBody.repository
          numberOfEvents: requestBody.numberOfEvents
      - text: Send a Falcon LogScale alert to app key {app_key}.
        slots:
          app_key: query.app_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/logicmonitor/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a LogicMonitor alert through OIM
      effect: write
      questions:
      - What fields does a LogicMonitor alert carry when sent to BigPanda?
      - Can I pass the datasource, datapoint and threshold from LogicMonitor in a test alert?
      instructions:
      - text: Send a LogicMonitor alert for host {host} on datasource {datasource} breaching {threshold}.
        slots:
          host: requestBody.host
          datasource: requestBody.datasource
          threshold: requestBody.threshold
      - text: Post LogicMonitor alert {alert_id} to my test integration.
        slots:
          alert_id: requestBody.alert_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/nagios/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send Nagios events through OIM
      effect: write
      questions:
      - How do Nagios host and service events get formatted for BigPanda?
      - Can I batch several Nagios events in one request to my integration?
      instructions:
      - text: Send these Nagios events {events} to integration app key {app_key}.
        slots:
          events: requestBody.events
          app_key: query.app_key
      - text: Post a sample Nagios check result to my test integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/newrelic/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a New Relic issue through OIM
      effect: write
      questions:
      - What does a New Relic issue notification look like when sent to BigPanda?
      - Can I include the alert policy and condition names from a New Relic workflow?
      instructions:
      - text: Send New Relic issue {title} with priority {priority} and state {state}.
        slots:
          title: requestBody.title
          priority: requestBody.priority
          state: requestBody.state
      - text: Post a New Relic workflow {workflow_name} notification to app key {app_key}.
        slots:
          workflow_name: requestBody.workflow_name
          app_key: query.app_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/prometheus/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send Prometheus Alertmanager alerts through OIM
      effect: write
      questions:
      - How do I point a Prometheus Alertmanager webhook receiver at BigPanda?
      - Can I send grouped Prometheus alerts with common labels and annotations?
      instructions:
      - text: Send Prometheus alerts {alerts} with status {status} from receiver {receiver}.
        slots:
          alerts: requestBody.alerts
          status: requestBody.status
          receiver: requestBody.receiver
      - text: Post a sample Alertmanager webhook to integration app key {app_key}.
        slots:
          app_key: query.app_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/scom_v2/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send Microsoft SCOM alerts through OIM
      effect: write
      questions:
      - What payload does BigPanda expect from System Center Operations Manager alerts?
      - Can I push a list of SCOM alerts at once to my SCOM integration?
      instructions:
      - text: Send these SCOM alerts {alerts} to app key {app_key}.
        slots:
          alerts: requestBody.alerts
          app_key: query.app_key
      - text: Post a test Microsoft SCOM alert batch to my integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/sciencelogic/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a ScienceLogic event through OIM
      effect: write
      questions:
      - What does a ScienceLogic event look like when forwarded to BigPanda?
      - Can I include the ScienceLogic event policy and entity name in a test alert?
      instructions:
      - text: Send ScienceLogic event {event_id} for entity {entity_name} with severity {severity}.
        slots:
          event_id: requestBody.event_id
          entity_name: requestBody.entity_name
          severity: requestBody.severity
      - text: Post a ScienceLogic event message {event_message} to my test integration.
        slots:
          event_message: requestBody.event_message
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/api/preprocess'].post
  update:
    x-apievangelist-phrasing:
      intent: Send OIM alerts with URL shortening preprocessing
      effect: write
      questions:
      - Can BigPanda shorten long URLs in alert tags before the payload is parsed?
      - What do I send to have OIM preprocess a payload with a config and sample payload?
      instructions:
      - text: Send this alert to OIM integration {app_key_h} and shorten its URL tags first.
        slots:
          app_key_h: header.app_key_h
      - text: Preprocess a payload for app key {app_key_h} using sample payload {sample_payload}.
        slots:
          app_key_h: header.app_key_h
          sample_payload: requestBody.sample_payload
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/api/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send alert events to a custom OIM integration
      effect: write
      questions:
      - How do I send alert events to a custom Open Integration Manager integration?
      - Which URL do OIM alert events go to, integrations.bigpanda.io or api.bigpanda.io?
      instructions:
      - text: Send these alert events to the custom OIM integration with app key {app_key_h}.
        slots:
          app_key_h: header.app_key_h
      - text: Push alert events into OIM integration {app_key_h} using the org token.
        slots:
          app_key_h: header.app_key_h
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/sitescope/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a SiteScope monitor alert through OIM
      effect: write
      questions:
      - What does a SiteScope monitor alert look like for BigPanda ingestion?
      - Can I include the SiteScope monitor group and target host in a test alert?
      instructions:
      - text: Send SiteScope alert {alert_name} from monitor {monitor_name} on host {target_host}.
        slots:
          alert_name: requestBody.alert_name
          monitor_name: requestBody.monitor_name
          target_host: requestBody.target_host
      - text: Post a sample SiteScope alert to app key {app_key}.
        slots:
          app_key: query.app_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/sqlsentry/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a SolarWinds SQL Sentry alert through OIM
      effect: write
      questions:
      - How are SQL Sentry database alerts formatted for BigPanda?
      - Can I send a SQL Sentry alert with just severity, content and time sent?
      instructions:
      - text: Send a SQL Sentry alert with severity {Severity} and content {Content}.
        slots:
          Severity: requestBody.Severity
          Content: requestBody.Content
      - text: Post a sample SolarWinds SQL Sentry alert to app key {app_key}.
        slots:
          app_key: query.app_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/splunk_v2/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a Splunk saved-search alert through OIM
      effect: write
      questions:
      - What does a Splunk saved search alert action send to BigPanda?
      - Can I include the Splunk search name and results link in the alert?
      instructions:
      - text: Send a Splunk alert from saved search {search_name} with results at {results_link}.
        slots:
          search_name: requestBody.search_name
          results_link: requestBody.results_link
      - text: Post a test Splunk search alert to integration app key {app_key}.
        slots:
          app_key: query.app_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/sumologic/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a Sumo Logic alert through OIM
      effect: write
      questions:
      - What payload does a Sumo Logic webhook connection send to BigPanda?
      - Can I send a Sumo Logic alert with a check, host and cluster as a test?
      instructions:
      - text: Send a Sumo Logic alert for check {check} on host {host} with status {status}.
        slots:
          check: requestBody.check
          host: requestBody.host
          status: requestBody.status
      - text: Post a sample Sumo Logic alert to my test integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/thousandeyes/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a ThousandEyes alert through OIM
      effect: write
      questions:
      - How do ThousandEyes network alert webhooks map into BigPanda?
      - Can I send a ThousandEyes event with its event type as a pipeline check?
      instructions:
      - text: Send ThousandEyes event {eventId} of type {eventType} to app key {app_key}.
        slots:
          eventId: requestBody.eventId
          eventType: requestBody.eventType
          app_key: query.app_key
      - text: Post a sample ThousandEyes alert webhook to my integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/tivoli/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send IBM Tivoli alerts through OIM
      effect: write
      questions:
      - What does an IBM Tivoli alert batch look like for BigPanda's Tivoli integration?
      - Can I forward Tivoli Netcool events into BigPanda to test the integration?
      instructions:
      - text: Send these Tivoli alerts {alerts} to integration app key {app_key}.
        slots:
          alerts: requestBody.alerts
          app_key: query.app_key
      - text: Post a sample IBM Tivoli alert list to my test integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/ariaops/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a VMware Aria Operations alert through OIM
      effect: write
      questions:
      - What does a VMware Aria Operations alert look like when sent to BigPanda?
      - Can I include Aria health, risk and efficiency values in a test alert?
      instructions:
      - text: Send an Aria Operations alert {alertName} for resource {resourceName} of kind {resourceKind}.
        slots:
          alertName: requestBody.alertName
          resourceName: requestBody.resourceName
          resourceKind: requestBody.resourceKind
      - text: Post a sample VMware Aria alert to app key {app_key}.
        slots:
          app_key: query.app_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oim/zabbix/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a Zabbix trigger alert through OIM
      effect: write
      questions:
      - What does a Zabbix trigger event look like when forwarded to BigPanda?
      - Can I send a Zabbix recovery status along with the original event?
      instructions:
      - text: Send Zabbix event {eventid} for host {host} with severity {severity}.
        slots:
          eventid: requestBody.eventid
          host: requestBody.host
          severity: requestBody.severity
      - text: Post a Zabbix trigger {trigger_id} alert to my test integration.
        slots:
          trigger_id: requestBody.trigger_id
      method: generated
      generated: '2026-09-26'