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

# Create an action definition



## OpenAPI

````yaml https://api.arklow.io/swagger/ui/json put /v1/orgs/{org_id}/actions/definitions
openapi: 3.1.0
info:
  title: Arklow
  description: Arklow's API
  version: 0.1.0
servers:
  - url: https://api.arklow.io
    description: Production
  - url: http://localhost:3123
    description: Local development
security:
  - apiKey: []
tags:
  - name: actions
  - name: api_keys
  - name: billing
  - name: config
  - name: credentials
  - name: destinations
  - name: invites
  - name: members
  - name: metrics
  - name: notifications
  - name: orgs
  - name: rules
  - name: sources
  - name: users
  - name: ingress
externalDocs:
  url: https://api.arklow.io/swagger/ui
paths:
  /v1/orgs/{org_id}/actions/definitions:
    put:
      tags:
        - actions
      summary: Create an action definition
      operationId: put_v1_orgs_by_org_id_actions_definitions
      parameters:
        - schema:
            type: string
            pattern: ^[0-9]+$
          in: path
          name: org_id
          required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - variant
                - schema
              properties:
                variant:
                  type: string
                version:
                  type: integer
                alias:
                  type: array
                  items:
                    type: string
                schema: {}
        required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - errors
                properties:
                  data:
                    anyOf:
                      - type: object
                        required:
                          - id
                          - org_id
                          - variant
                          - version
                          - alias
                          - schema
                        properties:
                          id:
                            type: string
                          org_id:
                            type: string
                          variant:
                            type: string
                          version:
                            type: integer
                          alias:
                            type: array
                            items:
                              type: string
                          schema: {}
                          deleted_at:
                            anyOf:
                              - type: 'null'
                              - type: string
                                format: date-time
                          destinations:
                            type: array
                            items:
                              type: object
                              required:
                                - id
                                - action_definition_id
                                - destination_id
                                - org_id
                              properties:
                                id:
                                  type: string
                                action_definition_id:
                                  type: string
                                destination_id:
                                  type: string
                                org_id:
                                  type: string
                                is_default:
                                  type: boolean
                                destination:
                                  allOf:
                                    - type: object
                                      required:
                                        - id
                                        - org_id
                                        - updated_at
                                      properties:
                                        id:
                                          type: string
                                        org_id:
                                          type: string
                                        updated_at:
                                          type: string
                                          format: date-time
                                        deleted_at:
                                          anyOf:
                                            - type: 'null'
                                            - type: string
                                              format: date-time
                                    - type: object
                                      required:
                                        - label
                                      properties:
                                        label:
                                          type: string
                                    - type: object
                                      properties:
                                        tags:
                                          anyOf:
                                            - type: object
                                              additionalProperties:
                                                type: string
                                            - type: 'null'
                                    - type: object
                                      properties:
                                        credential_id:
                                          anyOf:
                                            - type: string
                                              pattern: ^[0-9]+$
                                            - type: 'null'
                                    - anyOf:
                                        - type: object
                                          required:
                                            - type
                                            - config
                                          properties:
                                            type:
                                              type: string
                                              enum:
                                                - webhook
                                            config:
                                              type: object
                                              required:
                                                - url
                                              properties:
                                                url:
                                                  type: string
                                                  format: uri
                                                headers:
                                                  type: object
                                                  additionalProperties:
                                                    type: string
                                                signaling:
                                                  anyOf:
                                                    - type: object
                                                      required:
                                                        - enabled
                                                        - default
                                                      properties:
                                                        enabled:
                                                          type: boolean
                                                          enum:
                                                            - true
                                                        default:
                                                          anyOf:
                                                            - type: string
                                                              enum:
                                                                - ack
                                                            - type: string
                                                              enum:
                                                                - mod_ack
                                                      additionalProperties: false
                                                    - type: object
                                                      required:
                                                        - enabled
                                                      properties:
                                                        enabled:
                                                          type: boolean
                                                          enum:
                                                            - false
                                                        default:
                                                          anyOf:
                                                            - type: string
                                                              enum:
                                                                - ack
                                                            - type: string
                                                              enum:
                                                                - mod_ack
                                                      additionalProperties: false
                                                response_time_sla_ms:
                                                  type: integer
                                                  minimum: 1
                                              additionalProperties: false
                                        - type: object
                                          required:
                                            - type
                                            - config
                                          properties:
                                            type:
                                              type: string
                                              enum:
                                                - sdk
                                            config:
                                              type: object
                                              required:
                                                - namespace
                                              properties:
                                                namespace:
                                                  type: string
                                                signaling:
                                                  anyOf:
                                                    - type: object
                                                      required:
                                                        - enabled
                                                        - default
                                                      properties:
                                                        enabled:
                                                          type: boolean
                                                          enum:
                                                            - true
                                                        default:
                                                          anyOf:
                                                            - type: string
                                                              enum:
                                                                - ack
                                                            - type: string
                                                              enum:
                                                                - mod_ack
                                                      additionalProperties: false
                                                    - type: object
                                                      required:
                                                        - enabled
                                                      properties:
                                                        enabled:
                                                          type: boolean
                                                          enum:
                                                            - false
                                                        default:
                                                          anyOf:
                                                            - type: string
                                                              enum:
                                                                - ack
                                                            - type: string
                                                              enum:
                                                                - mod_ack
                                                      additionalProperties: false
                                                response_time_sla_ms:
                                                  type: integer
                                                  minimum: 1
                                              additionalProperties: false
                                        - type: object
                                          required:
                                            - type
                                            - config
                                          properties:
                                            type:
                                              type: string
                                              enum:
                                                - google_pubsub
                                            config:
                                              type: object
                                              required:
                                                - project_id
                                                - topic_id
                                              properties:
                                                project_id:
                                                  type: string
                                                topic_id:
                                                  type: string
                                                response_time_sla_ms:
                                                  type: integer
                                                  minimum: 1
                                        - type: object
                                          required:
                                            - type
                                            - config
                                          properties:
                                            type:
                                              type: string
                                              enum:
                                                - aws_sqs
                                            config:
                                              type: object
                                              required:
                                                - queue_url
                                              properties:
                                                queue_url:
                                                  type: string
                                                  format: uri
                                                region:
                                                  type: string
                                                response_time_sla_ms:
                                                  type: integer
                                                  minimum: 1
                                        - type: object
                                          required:
                                            - type
                                            - config
                                          properties:
                                            type:
                                              type: string
                                              enum:
                                                - mcp
                                            config:
                                              type: object
                                              required:
                                                - endpoint
                                              properties:
                                                endpoint:
                                                  type: string
                                                  format: uri
                                                response_time_sla_ms:
                                                  type: integer
                                                  minimum: 1
                                        - type: object
                                          required:
                                            - type
                                            - config
                                          properties:
                                            type:
                                              type: string
                                              enum:
                                                - default_sink
                                            config:
                                              type: object
                                              properties: {}
                                              additionalProperties: false
                      - type: 'null'
                  errors:
                    anyOf:
                      - type: array
                        items:
                          type: object
                          required:
                            - code
                            - message
                          properties:
                            code:
                              type: string
                            message:
                              type: string
                      - type: 'null'
components:
  securitySchemes:
    apiKey:
      type: apiKey
      name: x-arklow-auth
      in: header

````