openapi: 3.2.0
info:
  version: 1.0.0
  title: Paperform Papersign Webhooks API
  contact:
    name: Paperform API Support
    url: https://paperform.co
    email: support@paperform.co
servers:
- url: https://api.paperform.co/v1
security:
- bearerAuth: []
tags:
- name: Papersign Webhooks
paths:
  /papersign/folders/{id}/webhooks:
    get:
      parameters:
      - $ref: '#/components/parameters/papersignFolderID'
      description: 'This endpoint returns webhooks for a Papersign folder.

        Please note that this feature is exclusively available as part of the Papersign API.'
      operationId: getPapersignFolderWebhooks
      tags:
      - Papersign Webhooks
      responses:
        '200':
          description: 'Successfully retrieved a list of webhooks for a Papersign folder.

            '
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - ok
                  results:
                    type: object
                    properties:
                      webhooks:
                        $ref: '#/components/schemas/PapersignWebhook'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/Validation'
        '429':
          $ref: '#/components/responses/Throttled'
        5XX:
          $ref: '#/components/responses/Unexpected'
      summary: Get papersign folder webhooks
      x-summary-source: derived
    post:
      parameters:
      - $ref: '#/components/parameters/papersignFolderID'
      description: 'This endpoint returns a creates a new webhook for a Papersign Folder.

        Please note that this feature is exclusively available as part of the Papersign API.'
      operationId: postPapersignFolderWebhooks
      tags:
      - Papersign Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PapersignWebhookUpdate'
      responses:
        '200':
          description: 'Successfully created a webhook for a Papersign folder.

            '
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - ok
                  results:
                    type: object
                    properties:
                      webhook:
                        $ref: '#/components/schemas/PapersignWebhook'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/Validation'
        '429':
          $ref: '#/components/responses/Throttled'
        5XX:
          $ref: '#/components/responses/Unexpected'
      summary: Post papersign folder webhooks
      x-summary-source: derived
  /papersign/webhooks/{id}:
    put:
      parameters:
      - $ref: '#/components/parameters/papersignWebhookID'
      description: 'This endpoint updates a Papersign folder webhook.

        Please note that this feature is exclusively available as part of the Papersign API.'
      operationId: putPapersignFolderWebhooks
      tags:
      - Papersign Webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PapersignWebhookUpdate'
      responses:
        '200':
          description: 'Successfully updated a webhook for a Papersign folder.

            '
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - ok
                  results:
                    type: object
                    properties:
                      webhook:
                        $ref: '#/components/schemas/PapersignWebhook'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/Validation'
        '429':
          $ref: '#/components/responses/Throttled'
        5XX:
          $ref: '#/components/responses/Unexpected'
      summary: Put papersign folder webhooks
      x-summary-source: derived
    delete:
      parameters:
      - $ref: '#/components/parameters/papersignWebhookID'
      description: 'This endpoint deletes a Papersign folder webhook.

        Please note that this feature is exclusively available as part of the Papersign API.'
      operationId: deletePapersignFolderWebhooks
      tags:
      - Papersign Webhooks
      responses:
        '200':
          description: 'Successfully deleted a webhook for a Papersign folder.

            '
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - ok
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/Validation'
        '429':
          $ref: '#/components/responses/Throttled'
        5XX:
          $ref: '#/components/responses/Unexpected'
      summary: Delete papersign folder webhooks
      x-summary-source: derived
components:
  schemas:
    PapersignFolder:
      type: object
      properties:
        id:
          type: number
          format: int32
          readOnly: true
          description: The unique identifier of the folder.
          example: 9999
        name:
          type: string
          description: The name of the document.
          example: My Document
        parent_id:
          type:
          - number
          - 'null'
          format: int32
          description: The unique identifier of the parent folder.
          example: 9999
        space_id:
          type: number
          format: int32
          description: The unique identifier of the space.
          example: 8888
      required:
      - name
    PapersignWebhookUpdate:
      type: object
      properties:
        name:
          type: string
          description: The name of the webhook.
          example: My Webhook
        target_url:
          type: string
          format: uri
          description: The target URL for the webhook.
          example: https://example.com/webhook
        scope:
          type: string
          enum:
          - folder.direct_children
          - folder.all_descendants
          description: The scope of the webhook.
          example: folder.direct_children
        triggers:
          type: array
          minItems: 1
          description: The triggers for the webhook.
          example:
          - document.created
          - document.updated
          items:
            type: string
            enum:
            - document.sent
            - document.completed
            - document.cancelled
            - document.rejected
            - document.expired
            - signer.notified
            - signer.viewed
            - signer.consent_accepted
            - signer.nominated
            - signer.signed
    PapersignWebhook:
      type: object
      properties:
        id:
          type: number
          format: int64
          description: The ID of the webhook.
          example: 5d40fdaf174b4c0007043072
        target_url:
          type: string
          description: The target URL for the webhook.
          example: https://example.com/webhook
        scope:
          type: string
          enum:
          - folder.direct_children
          - folder.all_descendants
          description: The scope of the webhook.
          example: folder.direct_children
        folder:
          $ref: '#/components/schemas/PapersignFolder'
        triggers:
          type: array
          items:
            type: string
            enum:
            - document.sent
            - document.completed
            - document.cancelled
            - document.rejected
            - document.expired
            - signer.notified
            - signer.viewed
            - signer.consent_accepted
            - signer.nominated
            - signer.signed
          description: The triggers for the webhook.
          example:
          - document.completed
          - document.cancelled
    Error:
      type: object
      properties:
        status:
          type: string
          enum:
          - error
          example: error
        message:
          type: string
          description: An error message.
          example: Invalid request
        details:
          type: array
          description: Suggested actions to resolve the error.
          items:
            type: string
  responses:
    Throttled:
      description: Too Many Requests
      content:
        text/html:
          schema:
            type: string
            enum:
            - Too many requests.
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            allOf:
            - $ref: '#/components/schemas/Error'
            - properties:
                error_type:
                  type: string
                  enum:
                  - authentication
                  description: Token not provided for not valid.
    Forbidden:
      description: Not Permitted
      content:
        application/json:
          schema:
            type: object
            allOf:
            - $ref: '#/components/schemas/Error'
            - properties:
                error_type:
                  type: string
                  enum:
                  - permission
                  description: Not permitted to access requested resource.
    BadRequest:
      description: Invalid Request
      content:
        application/json:
          schema:
            type: object
            allOf:
            - $ref: '#/components/schemas/Error'
            - properties:
                error_type:
                  type: string
                  enum:
                  - validation
                  description: Invalid parameters provided.
    Unexpected:
      description: Unexpected Error
      content:
        application/json:
          schema:
            type: object
            allOf:
            - $ref: '#/components/schemas/Error'
            - properties:
                error_type:
                  type: string
                  enum:
                  - server_error
                  description: An unexpected error.
    Validation:
      description: Validation Error
      content:
        application/json:
          schema:
            type: object
            allOf:
            - $ref: '#/components/schemas/Error'
            - properties:
                error_type:
                  type: string
                  enum:
                  - validation
                  description: Invalid parameters provided.
    NotFound:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            allOf:
            - $ref: '#/components/schemas/Error'
            - properties:
                error_type:
                  type: string
                  enum:
                  - not_found
                  description: The requested resource was not found.
  parameters:
    papersignWebhookID:
      in: path
      required: true
      name: id
      schema:
        type: number
      description: The ID of the Papersign webhook.
      example: 9999
    papersignFolderID:
      in: path
      required: true
      name: id
      schema:
        type: number
      description: The ID of the Papersign folder.
      example: '9999'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
x-readme:
  explorer-enabled: true
  proxy-enabled: true