> ## Documentation Index > Fetch the complete documentation index at: https://docs.cotool.ai/llms.txt > Use this file to discover all available pages before exploring further. # Send a test payload to an unsaved output destination > Deliver an example payload to a configured-but-unsaved output destination so it can be verified before creating it. The send is real and may create a message/incident/issue/case in the destination. ## OpenAPI ````yaml https://app.cotool.ai/api/docs/openapi.json post /api/output-destinations/test openapi: 3.1.0 info: title: Cotool API version: 1.0.0 description: >- # Cotool API Documentation The Cotool API allows you to interact with the Cotool platform programmatically, enabling you to build powerful integrations and automate your workflows. ## Getting an API Key Follow these steps to generate your API key: 1. **Log in** to the Cotool web interface 2. **Navigate** to `/settings/api-keys` 3. **Click** "Generate Key" 4. **Copy and store** your API key securely ⚠️ *It won't be shown again* ## API Key Authentication For programmatic access and integrations, use your API key with the Authorization header: ```http Authorization: Bearer your_api_key_here ``` ```bash curl -X GET "https://app.cotool.ai/api/endpoint" \ -H "Authorization: Bearer your_api_key_here" \ -H "Content-Type: application/json" ``` servers: - url: https://app.cotool.ai description: Production server security: - ApiKeyAuth: [] paths: /api/output-destinations/test: post: tags: - Detections summary: Send a test payload to an unsaved output destination description: >- Deliver an example payload to a configured-but-unsaved output destination so it can be verified before creating it. The send is real and may create a message/incident/issue/case in the destination. requestBody: content: application/json: schema: type: object properties: outputType: type: string enum: - detection - response - acceptance-criteria - threat-intel - alert-escalation description: The context the destination is configured in payload: $ref: '#/components/schemas/JsonValue' description: The (possibly user-edited) example payload envelope to send destination: oneOf: - type: object properties: name: type: string minLength: 1 maxLength: 255 description: Human-readable name for this destination url: type: string format: uri description: The webhook URL to POST to authType: type: string enum: - bearer - header description: Type of authentication headerName: type: string description: Custom header name when authType is "header" token: type: string description: The authentication token type: type: string const: webhook required: - name - url - authType - type - type: object properties: type: type: string const: teams description: Destination type name: type: string minLength: 1 maxLength: 255 description: Human-readable name for this destination url: type: string format: uri description: The Microsoft Teams workflow webhook URL to POST to required: - type - name - url - type: object properties: type: type: string const: slack description: Destination type name: type: string minLength: 1 maxLength: 255 description: Human-readable name for this destination channelIds: type: array items: type: string minItems: 1 description: Slack channel IDs to post messages to required: - type - name - channelIds - type: object properties: type: type: string const: pagerduty description: Destination type name: type: string minLength: 1 maxLength: 255 description: Human-readable name for this destination severity: type: string enum: - critical - error - warning - info description: >- Default severity level for alerts (defaults to warning) source: type: string description: >- Optional source identifier (defaults to detection name) required: - type - name - type: object properties: type: type: string const: linear description: Destination type name: type: string minLength: 1 maxLength: 255 description: Human-readable name for this destination teamId: type: string minLength: 1 description: Linear team ID where issues should be created teamName: type: string description: Cached team name (for display) required: - type - name - teamId - type: object properties: type: type: string const: tines description: Destination type name: type: string minLength: 1 maxLength: 255 description: Human-readable name for this destination teamId: type: string pattern: ^\d+$ description: Tines team ID where cases should be created teamName: type: string description: Cached team name (for display) required: - type - name - teamId description: The unsaved destination configuration to test existingDestinationId: type: string format: uuid description: >- Existing destination being edited; used to preserve stored secrets when omitted from the unsaved config structuredOutputSchema: oneOf: - $ref: '#/components/schemas/CotoolJsonSchema' - type: 'null' description: >- For the response context: the agent structured-output schema, so the test send formats the payload the same way the real delivery path does agentName: type: string description: >- For the response context on non-webhook destinations: the agent name shown in the message header required: - outputType - payload - destination responses: '200': description: Successful response content: application/json: schema: type: object properties: success: type: boolean const: true description: Whether the test output was delivered destinationType: type: string enum: - webhook - teams - slack - pagerduty - linear - tines description: Type of destination the test was sent to detail: type: string description: >- Optional human-readable detail about the delivery (e.g. created issue identifier) required: - success - destinationType '400': description: Bad request — input validation failed or the request was malformed content: application/json: schema: $ref: '#/components/schemas/ValidationError' '401': description: Unauthorized — missing or invalid API key / session content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden — the authenticated user lacks the required permissions content: application/json: schema: $ref: '#/components/schemas/PermissionError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' x-codeSamples: - lang: shell label: cURL source: |- curl -X POST "https://app.cotool.ai/api/output-destinations/test" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"outputType":"detection","payload":null,"destination":{"name":"string","url":"string","authType":"bearer","headerName":"string","token":"string","type":"webhook"},"existingDestinationId":"string","structuredOutputSchema":null,"agentName":"string"}' components: schemas: JsonValue: anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' description: A JSON value (string, number, boolean, null, array, or object) CotoolJsonSchema: type: object properties: type: type: string enum: - string - number - boolean - 'null' - object - array title: type: string description: type: string properties: type: object additionalProperties: $ref: '#/components/schemas/CotoolJsonSchema' items: $ref: '#/components/schemas/CotoolJsonSchema' required: type: array items: type: string enum: type: array items: type: string additionalProperties: type: boolean x-cotool: type: object properties: presetId: type: string enum: - classification - markdown - templatedReport - toolCallEvidence viewerId: type: string additionalProperties: $ref: '#/components/schemas/JsonValue' required: - type description: >- A JSON Schema definition with Cotool-specific extensions for structured output presets ValidationError: type: object properties: error: type: string description: Error message describing what went wrong issues: type: array description: >- Detailed validation issues, present when request or response schema validation fails items: type: object additionalProperties: true required: - error Error: type: object properties: error: type: string description: Error message describing what went wrong required: - error PermissionError: type: object properties: error: type: string description: Error message describing what went wrong missingPerms: type: array description: Permissions the authenticated user is missing for this operation items: type: string required: - error securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API Key description: >- API Key authentication for programmatic access. Include your API key in the Authorization header as: `Bearer your_api_key_here` ````