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

# Endpoint to return sample data for the Zap editor, helping users test triggers and map fields before activating their Zap.

> See https://docs.zapier.com/platform/build/hook-trigger#perform-list

# Access control rules

- The requester is authenticated.



## OpenAPI

````yaml GET /api/v0/zapier/subscriptions/events/{event_kind}/sample
openapi: 3.1.0
info:
  title: Cantina Client API
  description: >-
    Endpoints available to client organizations. For an overview and
    authentication, see
    https://docs.cantina.xyz/for-organizations/getting-started/api-access.
  license:
    name: Cantina
    identifier: Cantina
  version: 0.1.0
servers: []
security: []
paths:
  /api/v0/zapier/subscriptions/events/{event_kind}/sample:
    get:
      tags:
        - zapier
      summary: |-
        Endpoint to return sample data for the Zap editor,
        helping users test triggers and map fields before activating their Zap.
      description: |-
        See https://docs.zapier.com/platform/build/hook-trigger#perform-list

        # Access control rules

        - The requester is authenticated.
      operationId: event_sample
      parameters:
        - name: event_kind
          in: path
          description: Kind of event
          required: true
          schema:
            $ref: '#/components/schemas/ZapierEventKind'
      responses:
        '200':
          description: List of zapier sample events
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ZapierEvent'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CantinaError'
        '401':
          description: Access not authorised
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CantinaError'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CantinaError'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CantinaError'
components:
  schemas:
    ZapierEventKind:
      type: string
      enum:
        - finding_created
        - finding_label_added
        - finding_comment_created
        - finding_updated
    ZapierEvent:
      oneOf:
        - allOf:
            - $ref: '#/components/schemas/FindingCreatedPayload'
            - type: object
              required:
                - kind
              properties:
                kind:
                  type: string
                  enum:
                    - finding_created
        - type: object
          required:
            - repositoryId
            - labelId
            - labelName
            - id
            - number
            - title
            - severity
            - status
            - createdAt
            - kind
          properties:
            repositoryId:
              type: string
              format: uuid
            labelId:
              type: string
              format: uuid
            labelName:
              type: string
            id:
              type: string
              format: uuid
            number:
              type: integer
              format: int32
            title:
              type: string
            severity:
              $ref: '#/components/schemas/FindingSeverity'
            likelihood:
              oneOf:
                - type: 'null'
                - $ref: '#/components/schemas/FindingLikelihood'
            impact:
              oneOf:
                - type: 'null'
                - $ref: '#/components/schemas/FindingImpact'
            status:
              $ref: '#/components/schemas/FindingStatus'
            createdAt:
              type: string
              format: date-time
            kind:
              type: string
              enum:
                - finding_label_added
        - type: object
          required:
            - repositoryId
            - findingId
            - findingNumber
            - findingTitle
            - commentId
            - commentPreview
            - commentVisibility
            - createdByUsername
            - createdAt
            - kind
          properties:
            repositoryId:
              type: string
              format: uuid
            findingId:
              type: string
              format: uuid
            findingNumber:
              type: integer
              format: int32
            findingTitle:
              type: string
            commentId:
              type: string
              format: uuid
            commentPreview:
              type: string
            commentVisibility:
              $ref: '#/components/schemas/CommentVisibility'
            parentCommentId:
              type:
                - string
                - 'null'
              format: uuid
            createdByUsername:
              type: string
            createdAt:
              type: string
              format: date-time
            kind:
              type: string
              enum:
                - finding_comment_created
        - type: object
          required:
            - repositoryId
            - id
            - number
            - title
            - field
            - changedAt
            - kind
          properties:
            repositoryId:
              type: string
              format: uuid
            id:
              type: string
              format: uuid
            number:
              type: integer
              format: int32
            title:
              type: string
            field:
              $ref: '#/components/schemas/FindingChangedField'
            oldValue:
              type:
                - string
                - 'null'
            newValue:
              type:
                - string
                - 'null'
            changedAt:
              type: string
              format: date-time
            kind:
              type: string
              enum:
                - finding_updated
    CantinaError:
      type: object
      description: Error returned by the Cantina API.
      required:
        - type
        - msg
      properties:
        type:
          $ref: '#/components/schemas/ErrorType'
        msg:
          type: string
          description: Error message for the user.
    FindingCreatedPayload:
      type: object
      description: |-
        Shared payload for `finding_created` events delivered to external
        subscribers (Zapier, Clarion). Keeping the shape in one place guarantees
        both integrations stay in sync when we add or change a field.
      required:
        - repositoryId
        - id
        - number
        - title
        - severity
        - status
        - createdAt
      properties:
        repositoryId:
          type: string
          format: uuid
        id:
          type: string
          format: uuid
        number:
          type: integer
          format: int32
        title:
          type: string
        severity:
          $ref: '#/components/schemas/FindingSeverity'
        likelihood:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/FindingLikelihood'
        impact:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/FindingImpact'
        status:
          $ref: '#/components/schemas/FindingStatus'
        assetGroup:
          type:
            - string
            - 'null'
          format: uuid
        assets:
          type:
            - array
            - 'null'
          items:
            type: string
            format: uuid
        createdAt:
          type: string
          format: date-time
    FindingSeverity:
      type: string
      description: Severity of a [`Finding`].
      enum:
        - critical
        - high
        - medium
        - low
        - informational
        - gas_optimization
    FindingLikelihood:
      type: string
      description: Likelihood of a [`Finding`].
      enum:
        - high
        - medium
        - low
    FindingImpact:
      type: string
      description: Impact of a [`Finding`].
      enum:
        - high
        - medium
        - low
    FindingStatus:
      type: string
      description: |-
        Status of a [`Finding`].
        Note that the `in_review` status is only applicable within bounties.
      enum:
        - new
        - in_review
        - disputed
        - rejected
        - spam
        - duplicate
        - confirmed
        - acknowledged
        - fixed
        - withdrawn
    CommentVisibility:
      type: string
      description: Visibility of a comment.
      enum:
        - public
        - private
        - internal
        - hidden
    FindingChangedField:
      type: string
      description: Represents the field that changed in a finding update event.
      enum:
        - status
        - reward
        - assigned_to
    ErrorType:
      type: string
      description: Type of error.
      enum:
        - email_not_verified
        - auth_invalid
        - auth_expired
        - auth_token_missing
        - auth_id_missing
        - invalid_password
        - disabled_user
        - tc_not_accepted
        - evicted
        - unauthorized
        - bad_request
        - not_found
        - forbidden
        - gone
        - payload_too_large
        - service_unavailable
        - internal_error

````