Skip to main content
Subdirectory: gateways/ · Body: the routing prompt The MDX body is the gateway’s routing prompt — the text that tells the gateway how to map tickets to tasks. See Prompting a Gateway for what to put in the body.

​
Frontmatter

FieldTypeRequiredDefaultDescription
orgstringYes—Organization the gateway belongs to. Gateways are always org-scoped.
typestringYes—Gateway integration type. servicenow is the default; runner is for sandbox benchmarking; custom-built types are configured by 2501 ahead of time.
activebooleanNotrueToggle the gateway on or off without deleting it.
metadataobjectNo{}Gateway-type-specific configuration — see Metadata by type.

​
Fields NOT supported

  • id, tenant_id, org_id, created_at, updated_at — system-set
  • routing_prompt field — comes from the MDX body, not frontmatter
  • Webhook registrations — managed separately via 2501 infra webhook

​
Metadata by type

​
ServiceNow (type: servicenow)

KeyTypeDescription
servicenow_escalation_group_idstringsys_user_group sys_id to escalate unresolved tickets to. See Escalation Groups.
dedup_window_minutesintegerHow far back to look when deduplicating incoming incidents. Default 30. Set -1 to disable deduplication.
assignment_group_filterstringOnly act on tickets assigned to this group
environment_filterstringOnly act on tickets matching this environment label

​
Runner (type: runner)

No required metadata. Used only for sandbox benchmarking via 2501 runner start.

​
Custom-built types

If your tenant has a custom gateway, the metadata schema is provided by your account team. The CLI does not validate custom metadata keys — anything you put under metadata: round-trips verbatim.

​
Example

gateways/servicenow.mdx
---
org: platform-team
type: servicenow
active: true
metadata:
  servicenow_escalation_group_id: a1b2c3d4e5f6a7b8c9d0
  dedup_window_minutes: 30
---
Only take tickets that target the web and database hosts. Skip tickets about
network appliances and end-user workstations.

For master-slave pairs (nyc1-app-jvm-01 and nyc1-app-jvm-02), always create
the task on both hosts in parallel and treat the ticket as resolved only
when both succeed.

​
Gotchas

  • type is fixed. Adding a new gateway type (a vendor we don’t have an integration for) requires a 2501 release — contact your account team. Configuring an existing type is pure MDX.
  • Webhook records are separate. A gateway’s MDX file doesn’t manage its webhooks. Recreate webhooks with 2501 infra webhook create --gateway-id ... (see Webhooks).
  • One gateway per org per type. ServiceNow + Runner in the same org is fine; two ServiceNow gateways in the same org is not.