COcotool
Output Destinations

Send a test payload to an output destination

Deliver an example payload to a single output destination so the configuration can be verified. The send is real and may create a message/incident/issue/case in the destination.

post/api/output-destinations/{destinationId}/test

Request

  • Base URL
    https://app.cotool.ai
  • Auth
    HTTP bearer

Path parameters

destinationIdstring uuid required

Request body

outputType'detection' | 'response' | 'acceptance-criteria' | 'threat-intel' | 'threat' | 'hunt-alert' | 'alert-escalation' | 'code-detection-auto-tune' | 'ingest-health' required

The context the destination is configured in; determines the example payload shape and formatting

agentNamestring

For the response context on non-webhook destinations: the agent name shown in the message header

Response

Successful response

successtrue required

Whether the test output was delivered

destinationType'webhook' | 'teams' | 'slack' | 'pagerduty' | 'linear' | 'tines' | 'incidentio' required

Type of destination the test was sent to

detailstring

Optional human-readable detail about the delivery (e.g. created issue identifier)

outputUrlstring uri

Direct URL to the created output when the destination provides one

outputLinkLabelstring

Human-readable label for the created output link

Changes

No recorded changes to this operation across all 2 revisions of this API.