Skip to main content

Integrations endpoints

Check integration status, read the Slack and Jira configuration, and post messages or findings alerts to Slack.

On this page
GET /api/v1/integrations/status
Connection state and health of your integrations.

Scope: member scope integrations:read

GET /api/v1/integrations/config
The Slack configuration summary.

Scope: member scope integrations:read

GET /api/v1/integrations/jira
The legacy Jira configuration.

Scope: member scope integrations:read

POST /api/v1/integrations/slack/notify
Post a message to Slack.

Scope: member scope integrations:notify

POST /api/v1/integrations/slack/findings
Post a formatted findings alert to Slack.

Scope: member scope integrations:notify

Connect Slack and Jira in the console first; see Slack and Jira. Secrets are write-only: these endpoints report whether a webhook, bot token or Jira token is set (has_webhook, has_bot_token, has_token), never the value.

Post a message

Slack message
curl -X POST https://api.breachline.io/api/v1/integrations/slack/notify \
  -H "Authorization: Bearer $BREACHLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message": "Nightly retest finished: 0 open critical findings."}'

message is required (up to 4,000 characters), and context adds up to 10 key-value fields to the message. Messages are sent through the Slack incoming webhook stored for your organization, so they always go to the channel that webhook was created for. channel is accepted but has no effect; the response echoes the value you sent. If Slack is not connected, the response is 409.

Post a findings alert

Findings alert
curl -X POST https://api.breachline.io/api/v1/integrations/slack/findings \
  -H "Authorization: Bearer $BREACHLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "scan_target": "staging.example.com",
    "findings": [
      {"title": "Reflected XSS in search", "severity": "high", "remediation": "Encode output in the results template."}
    ]
  }'

Each finding needs title and severity, and can include category, target, description, evidence_summary, remediation and jira_ticket (a ticket reference you supply, shown in the alert). Pass thread_ts to reply in an existing thread. As with messages, channel has no effect.

Jira configuration

GET /api/v1/integrations/jira returns the legacy Jira settings for your organization: configured, enabled, base_url, email, project_key, auto_ticket_severity and has_token. auto_ticket_severity is stored but not used: nothing files Jira issues automatically. See Jira.

Search documentation

Type to search guides, the API reference, the CLI and the console guide.

    Enter open↑ ↓ moveEsc close