> ## Documentation Index
> Fetch the complete documentation index at: https://docs.prisme.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Automation Webhook (GET)

> Trigger some automation from HTTP. GET/POST/PUT/PATCH/DELETE methods can all be used



## OpenAPI

````yaml /api-reference/swagger.yml get /v2/workspaces/{workspaceId}/webhooks/{automationSlug}*
openapi: 3.0.0
info:
  version: 1.0.0
  title: Prisme.ai APIs
  description: Prisme.ai APIs specifications
  termsOfService: https://www.prisme.ai/mentions-legales
  contact:
    name: Prisme.ai Support Team
    email: support@prisme.ai
    url: https://www.prisme.ai
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://api.studio.prisme.ai
    description: Prisme.ai Cloud
  - url: https://{customDomain}
    description: Self-hosted Prisme.ai instance
    variables:
      customDomain:
        default: api.your-prisme-instance.com
        description: API hostname of your self-hosted Prisme.ai deployment
  - url: http://localhost:3001
    description: Local development
security:
  - BearerAuth: []
  - OrgApiKeyAuth: []
  - BearerAuth: []
    OrgApiKeyAuth: []
tags:
  - name: API Gateway
    description: >-
      Authentication, session management, SSO providers, and user profile
      endpoints.
  - name: Prisme.ai Workspaces
    description: >-
      CRUD operations for workspaces and their resources (pages, apps,
      automations, imports, variables).
  - name: Prisme.ai Runtime
    description: Execute workspace automations and manage their runtime lifecycle.
  - name: Prisme.ai Events
    description: Event ingestion, delivery, and subscription filtering across the platform.
  - name: Organizations
    description: >-
      Manage organizations, members, roles, invites, groups, and org-level
      service accounts.
  - name: Subscriptions
    description: >-
      Manage organization subscription plans and tier assignments (SuperAdmin
      only).
  - name: Secrets
    description: Read and patch encrypted key-value secrets scoped to a workspace.
  - name: ApiKeys
    description: Create, list, rotate, and validate workspace-scoped API keys.
  - name: Permissions
    description: >-
      Share or unshare resources (workspaces, pages, …) with users via roles or
      fine-grained rules.
  - name: Monitoring
    description: Platform readiness checks across services (SuperAdmin only).
  - name: AuthProviders
paths:
  /v2/workspaces/{workspaceId}/webhooks/{automationSlug}*:
    get:
      tags:
        - Prisme.ai Runtime
      summary: Automation Webhook (GET)
      description: >-
        Trigger some automation from HTTP. GET/POST/PUT/PATCH/DELETE methods can
        all be used
      operationId: automationWebhookGet
      parameters:
        - name: workspaceId
          in: path
          description: Workspace ID, or slug prefixed with "slug:" (e.g. slug:my-workspace)
          required: true
          schema:
            type: string
        - name: automationSlug
          in: path
          description: >-
            Automation slug we will trigger. Can contain a slash in order to
            make subpath.
          required: true
          schema:
            type: string
        - in: query
          name: query
          schema:
            type: object
            additionalProperties: true
          style: form
          explode: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnyValue'
              description: >-
                Entire body will be passed as a payload to the triggered
                automation
          '*/*':
            schema:
              $ref: '#/components/schemas/AnyValue'
              description: >-
                Entire body will be passed as a payload to the triggered
                automation
      responses:
        '200':
          description: Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnyValue'
        '400':
          description: Object not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
        '403':
          description: Bad permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Object not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectNotFoundError'
components:
  schemas:
    AnyValue: {}
    GenericError:
      type: object
      properties:
        error:
          type: string
          example: ObjectNotFound
        message:
          type: string
        details:
          $ref: '#/components/schemas/AnyValue'
    ForbiddenError:
      type: object
      properties:
        error:
          type: string
          example: ForbiddenError
        message:
          type: string
          example: Forbidden
    ObjectNotFoundError:
      type: object
      properties:
        error:
          type: string
          example: ObjectNotFound
        message:
          type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    OrgApiKeyAuth:
      type: apiKey
      in: header
      name: x-prismeai-api-key

````