> ## 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 webhook fields

> Generate a webhook URL, secret, and any additional fields required to configure an external webhook for a trigger.



## OpenAPI

````yaml https://app.cotool.ai/api/docs/openapi.json get /api/agents/{agentId}/trigger/{source}/fields
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/agents/{agentId}/trigger/{source}/fields:
    get:
      tags:
        - Agent Triggers
      summary: Get webhook fields
      description: >-
        Generate a webhook URL, secret, and any additional fields required to
        configure an external webhook for a trigger.
      parameters:
        - in: path
          name: agentId
          description: Unique identifier of the agent
          schema:
            type: string
            format: uuid
            description: Unique identifier of the agent
          required: true
        - in: path
          name: source
          description: Source type for the trigger (e.g., jira, slack, linear, hackerone)
          schema:
            type: string
            description: Source type for the trigger (e.g., jira, slack, linear, hackerone)
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Whether the webhook fields were generated successfully
                  data:
                    type: object
                    properties:
                      secret:
                        type: string
                        description: Generated secret for webhook authentication
                      webhookUrl:
                        type: string
                        description: Generated webhook URL for external services to call
                      additionalFields:
                        oneOf:
                          - type: object
                            properties:
                              type:
                                type: string
                                const: jira
                              jiraUrl:
                                type: string
                                description: URL to Jira webhook configuration page
                            required:
                              - type
                              - jiraUrl
                          - type: object
                            properties:
                              type:
                                type: string
                                const: jira-automation
                              authHeader:
                                type: string
                                description: >-
                                  Header name for authentication
                                  (X-Webhook-Auth)
                              instructions:
                                type: string
                                description: >-
                                  Instructions for Jira Automation Send web
                                  request setup
                            required:
                              - type
                              - authHeader
                              - instructions
                          - type: object
                            properties:
                              type:
                                type: string
                                const: slack
                            required:
                              - type
                          - type: object
                            properties:
                              type:
                                type: string
                                const: linear
                              workspaceName:
                                type: string
                                description: Name of the Linear workspace
                            required:
                              - type
                              - workspaceName
                          - type: object
                            properties:
                              type:
                                type: string
                                const: webhook
                              authHeader:
                                type: string
                                description: >-
                                  Header name for authentication
                                  (X-Webhook-Auth)
                              instructions:
                                type: string
                                description: Simple instructions for webhook setup
                            required:
                              - type
                              - authHeader
                              - instructions
                          - type: object
                            properties:
                              type:
                                type: string
                                const: hackerone
                              signatureHeader:
                                type: string
                                description: >-
                                  Header HackerOne uses to sign deliveries
                                  (X-H1-Signature)
                              instructions:
                                type: string
                                description: Instructions for HackerOne webhook setup
                            required:
                              - type
                              - signatureHeader
                              - instructions
                          - type: object
                            properties:
                              type:
                                type: string
                                const: bugcrowd
                              signatureHeader:
                                type: string
                                description: >-
                                  Header Bugcrowd uses to sign deliveries
                                  (X-Bugcrowd-Digest)
                              instructions:
                                type: string
                                description: >-
                                  Instructions for configuring an Outgoing
                                  Webhook in Bugcrowd
                            required:
                              - type
                              - signatureHeader
                              - instructions
                        description: >-
                          Additional configuration fields specific to the
                          trigger source type
                    required:
                      - secret
                      - webhookUrl
                      - additionalFields
                    description: Webhook configuration data
                required:
                  - success
                  - data
                description: >-
                  Response containing webhook configuration fields for external
                  service setup
        '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/agents/:agentId/trigger/:source/fields" \
              -H "Authorization: Bearer YOUR_API_KEY" \
              -H "Content-Type: application/json"
components:
  schemas:
    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`

````