> ## 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.

# Get alert source payload

> Retrieve the stored raw source payload for an alert.



## OpenAPI

````yaml https://app.cotool.ai/api/docs/openapi.json get /api/alerts/{alertId}/source-payloads/{sourcePayloadId}
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/alerts/{alertId}/source-payloads/{sourcePayloadId}:
    get:
      tags:
        - Alerts
      summary: Get alert source payload
      description: Retrieve the stored raw source payload for an alert.
      parameters:
        - in: path
          name: alertId
          description: Alert UUID or human-readable display ID
          schema:
            type: string
            description: Alert UUID or human-readable display ID
          required: true
        - in: path
          name: sourcePayloadId
          description: Alert source payload UUID
          schema:
            type: string
            format: uuid
            description: Alert source payload UUID
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  sourcePayload:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Source payload identifier
                      organizationId:
                        type: string
                        format: uuid
                        description: Organization that owns the payload
                      alertId:
                        type: string
                        format: uuid
                        description: Alert this payload belongs to
                      source:
                        type: object
                        properties:
                          category:
                            type: string
                            enum:
                              - detection
                              - trigger
                              - hunting
                            description: >-
                              Broad alert source category. Hunting is reserved
                              for future threat-intel exposure alerts.
                          name:
                            type: string
                            enum:
                              - cotool_detection
                              - hunting
                              - jira
                              - jira-automation
                              - slack
                              - linear
                              - cron
                              - webhook
                              - email
                              - bugcrowd
                              - hackerone
                            description: >-
                              Filter-oriented alert source name. Trigger-created
                              alerts use the trigger type.
                          triggerType:
                            type:
                              - string
                              - 'null'
                            enum:
                              - jira
                              - jira-automation
                              - slack
                              - linear
                              - cron
                              - webhook
                              - email
                              - bugcrowd
                              - hackerone
                              - null
                            description: Trigger source when category is trigger
                        required:
                          - category
                          - name
                          - triggerType
                        description: Filter-oriented source attribution for an alert.
                      externalProvider:
                        type:
                          - string
                          - 'null'
                        enum:
                          - jira
                          - jira-automation
                          - slack
                          - linear
                          - cron
                          - webhook
                          - email
                          - bugcrowd
                          - hackerone
                          - null
                        description: >-
                          External trigger provider when the source is an
                          external trigger
                      originTriggerId:
                        type:
                          - string
                          - 'null'
                        format: uuid
                        description: Trigger that produced the payload, when applicable
                      originRunId:
                        type:
                          - string
                          - 'null'
                        format: uuid
                        description: Run that produced the payload, when applicable
                      contentType:
                        type: string
                        const: application/json
                      storageKind:
                        type: string
                        enum:
                          - inline_json
                          - kv
                      sha256:
                        type: string
                        description: SHA-256 digest of the JSON payload
                      sizeBytes:
                        type: integer
                        minimum: 0
                      payload:
                        $ref: '#/components/schemas/JsonValue'
                        description: Raw source payload for alert triage
                      createdAt:
                        type: string
                        description: ISO timestamp when the payload was created
                      updatedAt:
                        type: string
                        description: ISO timestamp when the payload was last updated
                    required:
                      - id
                      - organizationId
                      - alertId
                      - source
                      - externalProvider
                      - originTriggerId
                      - originRunId
                      - contentType
                      - storageKind
                      - sha256
                      - sizeBytes
                      - payload
                      - createdAt
                      - updatedAt
                required:
                  - sourcePayload
        '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 GET
            "https://app.cotool.ai/api/alerts/:alertId/source-payloads/:sourcePayloadId"
            \
              -H "Authorization: Bearer YOUR_API_KEY" \
              -H "Content-Type: application/json"
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)
    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`

````