Dust Triggers API

openapi: 3.2.0
info:
  title: DUST API Documentation Triggers API
  version: 1.0.2
  description: The OpenAPI specification for the Dust.tt API
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
- url: https://dust.tt
  description: Dust.tt API (us-central1)
- url: https://eu.dust.tt
  description: Dust.tt API (europe-west1)
tags:
- name: Triggers
  description: Triggers
paths:
  /api/v1/w/{wId}/triggers/{tId}:
    get:
      summary: Get a trigger
      description: 'Get one agent trigger (scheduled run or webhook) by id. Requires a workspace admin API

        key.'
      tags:
      - Triggers
      parameters:
      - in: path
        name: wId
        required: true
        description: ID of the workspace
        schema:
          type: string
      - in: path
        name: tId
        required: true
        description: ID of the trigger
        schema:
          type: string
      security:
      - BearerAuth: []
      responses:
        '200':
          description: The trigger
          content:
            application/json:
              schema:
                type: object
                properties:
                  trigger:
                    $ref: '#/components/schemas/Trigger'
        '401':
          description: Unauthorized. Invalid or missing authentication token.
        '403':
          description: Forbidden. Requires a workspace admin API key.
        '404':
          description: Workspace or trigger not found.
      operationId: getApiV1WByWIdTriggersByTId
      x-operation-id-source: derived
  /api/v1/w/{wId}/triggers/hooks/{webhookSourceId}:
    post:
      summary: Receive external webhook to trigger flows
      description: Skeleton endpoint that verifies workspace and webhook source and logs receipt.
      tags:
      - Triggers
      security:
      - BearerAuth: []
      parameters:
      - in: path
        name: wId
        required: true
        description: Workspace ID
        schema:
          type: string
      - in: path
        name: webhookSourceId
        required: true
        description: Webhook source ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Webhook received
        '400':
          description: Invalid request
        '404':
          description: Workspace or webhook source not found
      operationId: postApiV1WByWIdTriggersHooksByWebhookSourceId
      x-operation-id-source: derived
  /api/v1/w/{wId}/triggers:
    get:
      summary: List triggers
      description: 'List the agent triggers (scheduled runs and webhooks) configured across the workspace

        identified by {wId}. Requires a workspace admin API key.'
      tags:
      - Triggers
      parameters:
      - in: path
        name: wId
        required: true
        description: ID of the workspace
        schema:
          type: string
      - in: query
        name: kind
        required: false
        description: Filter by trigger kind
        schema:
          type: string
          enum:
          - schedule
          - webhook
      - in: query
        name: limit
        required: false
        description: Maximum number of triggers to return (default 50, max 100)
        schema:
          type: integer
      - in: query
        name: offset
        required: false
        description: Number of triggers to skip, for pagination
        schema:
          type: integer
      security:
      - BearerAuth: []
      responses:
        '200':
          description: The workspace's triggers
          content:
            application/json:
              schema:
                type: object
                properties:
                  triggers:
                    type: array
                    items:
                      $ref: '#/components/schemas/Trigger'
        '400':
          description: Bad Request. Invalid query parameters.
        '401':
          description: Unauthorized. Invalid or missing authentication token.
        '403':
          description: Forbidden. Requires a workspace admin API key.
        '404':
          description: Workspace not found.
      operationId: getApiV1WByWIdTriggers
      x-operation-id-source: derived
components:
  schemas:
    Trigger:
      type: object
      required:
      - id
      - sId
      - name
      - agentConfigurationId
      - kind
      - status
      - createdAt
      - executionMode
      - configuration
      properties:
        id:
          type: integer
          example: 12345
        sId:
          type: string
          description: Unique string identifier for the trigger
          example: 0ec9852c2f
        name:
          type: string
          example: Daily summary
        agentConfigurationId:
          type: string
          description: sId of the agent this trigger runs
          example: 8f3a1c2d9e
        kind:
          type: string
          enum:
          - schedule
          - webhook
        status:
          type: string
          enum:
          - enabled
          - disabled
          - disabled_by_manager
          - relocating
          - downgraded
        createdAt:
          type: integer
          example: 1625097600
        customPrompt:
          type:
          - string
          - 'null'
        naturalLanguageDescription:
          type:
          - string
          - 'null'
        executionMode:
          type: string
          enum:
          - user_pool
          - workspace_pool
        configuration:
          type: object
          description: 'For `kind: schedule`, either a cron config (`cron`, `timezone`) or an interval

            config (`intervalDays`, `dayOfWeek`, `hour`, `minute`, `timezone`). For

            `kind: webhook`, `{ includePayload, event?, filter? }`.

            '
        webhookSource:
          type:
          - object
          - 'null'
          description: 'Present only for `kind: webhook` triggers'
          properties:
            name:
              type: string
            provider:
              type: string
              example: github
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Your DUST API key is a Bearer token.
x-provenance:
  method: harvested
  publisher: Dust
  source: https://raw.githubusercontent.com/dust-tt/dust/refs/heads/main/front-api/public/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)