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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for BigPanda OIM Configuration API
version: 1.0.0
extends: openapi/bigpanda-oim-configuration-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: 3
- target: $.paths['/configurations/alerts/oim/{app_key_p}'].get
update:
x-apievangelist-phrasing:
intent: Get an OIM integration configuration
effect: read
questions:
- What parsing rules does my custom Open Integration Manager integration use?
- Can I read back the saved OIM config for an integration?
instructions:
- text: Get the OIM configuration for app key {app_key_p}.
slots:
app_key_p: path.app_key_p
- text: Show the active OIM parsing rules of integration {app_key_p}.
slots:
app_key_p: path.app_key_p
method: generated
generated: '2026-09-26'
- target: $.paths['/configurations/alerts/oim/{app_key_p}'].post
update:
x-apievangelist-phrasing:
intent: Create or update an OIM integration configuration
effect: write
questions:
- How do I define how a custom inbound alert payload maps to BigPanda tags?
- Do new OIM integrations still flatten arrays by default?
instructions:
- text: Save OIM config {config} for integration {app_key_p}.
slots:
config: requestBody.config
app_key_p: path.app_key_p
- text: Update the OIM parsing rules of {app_key_p} from sample payload {sample_payload}.
slots:
app_key_p: path.app_key_p
sample_payload: requestBody.sample_payload
method: generated
generated: '2026-09-26'
- target: $.paths['/configurations/alerts/oim/{app_key}/preprocessor'].post
update:
x-apievangelist-phrasing:
intent: Add preprocessor functions to an OIM config
effect: write
questions:
- Can I run URL shortening on incoming payloads before OIM parsing rules apply?
- What's the rate limit for updating an OIM config with preprocessors?
instructions:
- text: Add preprocessor functions to OIM integration {app_key} with config {config}.
slots:
app_key: path.app_key
config: requestBody.config
- text: Enable URL shortening preprocessing on {app_key} using sample {sample_payload}.
slots:
app_key: path.app_key
sample_payload: requestBody.sample_payload
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.