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

# Change trigger settings

> Change some of a trigger's settings in one update, keeping the rest. allowedChannelIds applies only to Slack triggers and schedule only to cron triggers.



## OpenAPI

````yaml https://app.cotool.ai/api/docs/openapi.json patch /api/agents/{agentId}/trigger/{triggerId}
openapi: 3.1.0
info:
  title: Cotool API
  version: 1.0.0
  description: >-
    The Cotool REST API. Authenticate with an API key from `/settings/api-keys`
    sent as `Authorization: Bearer <key>`.


    Authentication, error formats, pagination, and common integration recipes
    are documented in the [API
    overview](https://docs.cotool.ai/api-reference/introduction). Endpoints
    marked **Deprecated** keep working; each one's description names its
    replacement.
servers:
  - url: https://app.cotool.ai
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Agents
    description: Create, update, run, and version agents.
  - name: Agent Runs
    description: Inspect agent runs, submit feedback, and read evaluation metrics.
  - name: Agent Triggers
    description: Webhook, schedule, and integration triggers that start agent runs.
  - name: Agents as Code
    description: Validate agents and skills defined as YAML in a Git repository.
  - name: Skills
    description: Reusable instructions and tool grants attached to agents.
  - name: Chat
    description: Chat sessions and their transcripts.
  - name: Alerts
    description: Alert triage, routing, and escalation notifications.
  - name: Output Destinations
    description: Webhook, Slack, Jira, and Linear destinations for agent output.
  - name: Detections
    description: Detection agents, detection hits, and the Cotool detection library.
  - name: Hunt
    description: Autonomous hunt threats, gaps, and settings.
  - name: Intel
    description: Threat-intelligence feed items, indicators, and sources.
  - name: Threat Model
    description: The organization threat model and its version history.
  - name: MITRE Coverage
    description: MITRE ATT&CK coverage across detections.
  - name: Tools
    description: Connected tool integrations and captured tool output.
  - name: CLIs
    description: Connected CLI integrations.
  - name: Artifacts
    description: Files and reports produced by agent runs.
  - name: Audit Logs
    description: Organization audit log export and event catalog.
  - name: Users
    description: Users, memberships, and the current session.
  - name: Roles
    description: Role-based permissions.
  - name: Organizations
    description: Organization-level metrics.
paths:
  /api/agents/{agentId}/trigger/{triggerId}:
    patch:
      tags:
        - Agent Triggers
      summary: Change trigger settings
      description: >-
        Change some of a trigger's settings in one update, keeping the rest.
        allowedChannelIds applies only to Slack triggers and schedule only to
        cron triggers.
      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: triggerId
          description: Unique identifier of the trigger
          schema:
            type: string
            format: uuid
            description: Unique identifier of the trigger
          required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 200
                description:
                  type: string
                  maxLength: 1000
                allowedChannelIds:
                  type: array
                  items:
                    type: string
                    minLength: 1
                  minItems: 1
                  maxItems: 100
                  description: 'Slack triggers only: replaces the channels it answers in'
                schedule:
                  type: string
                  minLength: 1
                  maxLength: 100
                  description: 'Cron triggers only: a cron expression'
                enabled:
                  type: boolean
                eventMode:
                  type: string
                  enum:
                    - direct
                    - alert_source
                  description: >-
                    Whether an inbound event runs the configured agent directly
                    or creates a Cotool alert before routing to the agent.
              additionalProperties: false
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      agentId:
                        type: string
                        format: uuid
                      organizationId:
                        type: string
                        format: uuid
                      source:
                        type: string
                        enum:
                          - jira
                          - jira-automation
                          - slack
                          - linear
                          - cron
                          - webhook
                          - email
                          - bugcrowd
                          - hackerone
                          - zscaler
                          - darktrace
                          - seon
                      eventMode:
                        type: string
                        enum:
                          - direct
                          - alert_source
                        description: >-
                          First-class event behavior. Missing only on legacy
                          serialized snapshots.
                      name:
                        type: string
                      description:
                        type:
                          - string
                          - 'null'
                      enabled:
                        type: boolean
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                      secret:
                        type:
                          - string
                          - 'null'
                      cronSchedule:
                        type:
                          - string
                          - 'null'
                      emailAddress:
                        type:
                          - string
                          - 'null'
                      config:
                        type: object
                        additionalProperties: {}
                      lastRunAttemptedAt:
                        type:
                          - string
                          - 'null'
                      lastRunSucceededAt:
                        type:
                          - string
                          - 'null'
                    required:
                      - id
                      - agentId
                      - organizationId
                      - source
                      - name
                      - enabled
                      - createdAt
                      - updatedAt
                      - config
                required:
                  - success
                  - data
        '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 PATCH
            "https://app.cotool.ai/api/agents/:agentId/trigger/:triggerId" \
              -H "Authorization: Bearer YOUR_API_KEY" \
              -H "Content-Type: application/json" \
              -d '{"name":"string","description":"string","allowedChannelIds":["string"],"schedule":"string","enabled":true,"eventMode":"direct"}'
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`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.