nCino Webhooks API

The Webhooks API from nCino — 6 operation(s) for webhooks.

OpenAPI Specification

ncino-webhooks-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Ncino Webhooks API
  version: '1.0'
  description: 'Operations tagged Webhooks across 3 of this provider''s published API definitions: ncino-evault-openapi.json, ncino-mortgage-openapi.yml, ncino-mortgage-webhooks-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://evault.ncino.com/api
  description: Production server
- url: https://api.ncinomortgage.com
  description: Production server
tags:
- name: Webhooks
paths:
  /webhooks:
    x-acl: webhooks
    servers:
    - url: https://evault.ncino.com/api
      description: Production server
    put:
      summary: Create a webhook configuration
      description: Creates a <Glossary>webhook</Glossary> — a URL eVault calls when subscribed <Glossary>webhook event</Glossary>s fire — with its <Glossary>signing key</Glossary> and the set of events it subscribes to.
      operationId: addWebhookConfiguration
      tags:
      - Webhooks
      requestBody:
        description: In order to create a webhook configuration, all of the following must be included in the request body
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/add_webhook_configuration_put'
      responses:
        '200':
          description: Created webhook configuration
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/default_success_response'
                - type: object
                  properties:
                    data:
                      type: object
                      properties:
                        id:
                          $ref: '#/components/schemas/guid'
        '400':
          description: Validation error
          $ref: '#/paths/~1webhooks/put/responses/401'
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '500':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/500_error_response'
      security:
      - bearerAuth: []
    post:
      tags:
      - Webhooks
      operationId: webhooks-create
      parameters:
      - $ref: '#/components/parameters/ApiVersionHeader'
      responses:
        '201':
          description: Created webhook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceCreated'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/ApiVersionResponseHeader'
            X-Api-Supported-Versions:
              $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
        '409':
          description: Webhook already exists for the given URL
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSet'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/ApiVersionResponseHeader'
            X-Api-Supported-Versions:
              $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      description: This endpoint will create a new <<glossary:webhook>> record.
      summary: Create a new webhook record
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookPostBody'
      security:
      - bearerAuth: []
    get:
      tags:
      - Webhooks
      operationId: webhooks-index
      parameters:
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/CreatedAfter'
      - $ref: '#/components/parameters/CreatedBefore'
      - $ref: '#/components/parameters/UpdatedAfter'
      - $ref: '#/components/parameters/UpdatedBefore'
      - $ref: '#/components/parameters/ApiVersionHeader'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookPagination'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/ApiVersionResponseHeader'
            X-Api-Supported-Versions:
              $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      description: This endpoint will retrieve all <<glossary:webhook>> records.
      summary: Retrieve all webhook records
      security:
      - bearerAuth: []
  /webhooks/{webhook_id}:
    x-acl: webhooks
    servers:
    - url: https://evault.ncino.com/api
      description: Production server
    get:
      summary: Get a webhook configuration
      description: Retrieves a <Glossary>webhook</Glossary> configuration, including the <Glossary>webhook event</Glossary>s it subscribes to.
      operationId: getWebhookConfiguration
      tags:
      - Webhooks
      parameters:
      - name: webhook_id
        description: The unique identifier for a webhook configuration
        required: true
        in: path
        schema:
          $ref: '#/components/schemas/guid'
      responses:
        '200':
          description: Webhook configuration
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/default_success_response'
                - type: object
                  properties:
                    data:
                      $ref: '#/components/schemas/webhook_configuration_response'
        '401':
          $ref: '#/paths/~1webhooks/put/responses/401'
        '500':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/500_get_error_response'
      security:
      - bearerAuth: []
    post:
      summary: Edit a webhook configuration
      description: Updates an existing <Glossary>webhook</Glossary> configuration's name, URL, <Glossary>signing key</Glossary>, enabled state, or subscribed events.
      operationId: editWebhookConfiguration
      tags:
      - Webhooks
      parameters:
      - $ref: '#/paths/~1webhooks~1%7Bwebhook_id%7D/get/parameters/0'
      requestBody:
        description: All fields are optional; only the fields included in the request body are updated. The nCino webhook configuration cannot be edited.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/edit_webhook_configuration_post'
      responses:
        '200':
          description: Updated webhook configuration
          $ref: '#/paths/~1webhooks/put/responses/200'
        '400':
          description: Validation error
          $ref: '#/paths/~1webhooks/put/responses/401'
        '401':
          $ref: '#/paths/~1webhooks/put/responses/401'
        '500':
          description: Error
          $ref: '#/paths/~1webhooks/put/responses/500'
      security:
      - bearerAuth: []
    delete:
      summary: Delete a webhook configuration
      description: Deletes a <Glossary>webhook</Glossary> configuration.
      operationId: deleteWebhookConfiguration
      tags:
      - Webhooks
      parameters:
      - $ref: '#/paths/~1webhooks~1%7Bwebhook_id%7D/get/parameters/0'
      responses:
        '200':
          description: Deleted webhook configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/default_success_response'
        '400':
          description: Validation error
          $ref: '#/paths/~1webhooks/put/responses/401'
        '401':
          $ref: '#/paths/~1webhooks/put/responses/401'
        '500':
          description: Error
          $ref: '#/paths/~1webhooks/put/responses/500'
      security:
      - bearerAuth: []
    patch:
      tags:
      - Webhooks
      operationId: webhooks-update
      parameters:
      - name: webhook_id
        description: Webhook ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - $ref: '#/components/parameters/ApiVersionHeader'
      responses:
        '204':
          description: Updated webhook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoContent'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/ApiVersionResponseHeader'
            X-Api-Supported-Versions:
              $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      description: This endpoint will update a <<glossary:webhook>> record.
      summary: Update a webhook record
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookPatchBody'
      security:
      - bearerAuth: []
  /webhooks/{webhook_id}/active-status:
    x-acl: webhooks
    servers:
    - url: https://evault.ncino.com/api
      description: Production server
    post:
      summary: Update a webhook configuration's active status
      description: Enables or disables a <Glossary>webhook</Glossary> configuration.
      operationId: updateWebhookConfigurationActiveStatus
      tags:
      - Webhooks
      parameters:
      - $ref: '#/paths/~1webhooks~1%7Bwebhook_id%7D/get/parameters/0'
      requestBody:
        description: Enables or disables the webhook configuration
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/webhook_active_status_post'
      responses:
        '200':
          description: Updated active status
          $ref: '#/paths/~1webhooks~1%7Bwebhook_id%7D/delete/responses/200'
        '400':
          description: Validation error
          $ref: '#/paths/~1webhooks/put/responses/401'
        '401':
          $ref: '#/paths/~1webhooks/put/responses/401'
        '500':
          description: Error
          $ref: '#/paths/~1webhooks/put/responses/500'
      security:
      - bearerAuth: []
  /webhooks/{webhook_id}/test:
    x-acl: webhooks
    servers:
    - url: https://evault.ncino.com/api
      description: Production server
    post:
      summary: Test a webhook configuration
      description: Sends a test event to a <Glossary>webhook</Glossary>'s configured URL and reports whether delivery succeeded.
      operationId: testWebhookConfiguration
      tags:
      - Webhooks
      parameters:
      - $ref: '#/paths/~1webhooks~1%7Bwebhook_id%7D/get/parameters/0'
      responses:
        '200':
          description: Sends a test event to the configured URL and returns whether it succeeded
          $ref: '#/paths/~1webhooks~1%7Bwebhook_id%7D/delete/responses/200'
        '400':
          description: Validation error
          $ref: '#/paths/~1webhooks/put/responses/401'
        '401':
          $ref: '#/paths/~1webhooks/put/responses/401'
        '500':
          description: Error
          $ref: '#/paths/~1webhooks/put/responses/500'
      security:
      - bearerAuth: []
  /webhooks/{webhook_id}/test_events:
    servers:
    - url: https://api.ncinomortgage.com
      description: Production server
    post:
      tags:
      - Webhooks
      operationId: webhooks-test_events
      parameters:
      - name: webhook_id
        description: Webhook ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - $ref: '#/components/parameters/ApiVersionHeader'
      responses:
        '200':
          description: Successfully sent webhook request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookTestResponse'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/ApiVersionResponseHeader'
            X-Api-Supported-Versions:
              $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      description: Use this endpoint to test events being sent to your <<glossary:webhook>>.
      summary: Perform test event on a webhook
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/JobStatusChangedTestEvent0'
              - $ref: '#/components/schemas/LoanAppStartedTestEvent0'
              - $ref: '#/components/schemas/LoanAppUpdatedTestEvent0'
              - $ref: '#/components/schemas/LoanAppSubmittedTestEvent0'
              - $ref: '#/components/schemas/LoanAppImportedTestEvent0'
              - $ref: '#/components/schemas/LoanAppAbandonedTestEvent0'
              - $ref: '#/components/schemas/DocumentUploadedTestEvent0'
              - $ref: '#/components/schemas/DocumentCreatedTestEvent0'
              - $ref: '#/components/schemas/DocumentUpdatedTestEvent0'
              - $ref: '#/components/schemas/LoanMilestoneUpdatedTestEvent0'
              - $ref: '#/components/schemas/LoanMilestoneCompletedTestEvent0'
              - $ref: '#/components/schemas/LoanCreatedTestEvent0'
              - $ref: '#/components/schemas/LoanUpdatedTestEvent0'
              - $ref: '#/components/schemas/LoanDeletedTestEvent0'
              - $ref: '#/components/schemas/LoanActivatedTestEvent0'
              - $ref: '#/components/schemas/LoanDeactivatedTestEvent0'
              - $ref: '#/components/schemas/MilestonesReorderedTestEvent0'
              - $ref: '#/components/schemas/MilestoneCreatedTestEvent0'
              - $ref: '#/components/schemas/MilestoneDeletedTestEvent0'
              - $ref: '#/components/schemas/OrganizationCreatedTestEvent0'
              - $ref: '#/components/schemas/OrganizationDeletedTestEvent0'
              - $ref: '#/components/schemas/StateLicenseCreatedTestEvent0'
              - $ref: '#/components/schemas/StateLicenseUpdatedTestEvent0'
              - $ref: '#/components/schemas/StateLicenseDeletedTestEvent0'
              - $ref: '#/components/schemas/AccountAssignmentCreatedTestEvent0'
              - $ref: '#/components/schemas/AccountAssignmentDeletedTestEvent0'
              - $ref: '#/components/schemas/LoanOfficerPromotedTestEvent0'
              - $ref: '#/components/schemas/LoanOfficerDemotedTestEvent0'
              - $ref: '#/components/schemas/UserCreatedTestEvent0'
              - $ref: '#/components/schemas/UserUpdatedTestEvent0'
              - $ref: '#/components/schemas/UserEnabledTestEvent0'
              - $ref: '#/components/schemas/UserDisabledTestEvent0'
              - $ref: '#/components/schemas/UserFirstLoginTestEvent0'
              - $ref: '#/components/schemas/UserDeletedTestEvent0'
              - $ref: '#/components/schemas/VerificationAvailableTestEvent0'
              discriminator:
                propertyName: event
                mapping:
                  job_status_changed: '#/components/schemas/JobStatusChangedTestEvent0'
                  loan_app_started: '#/components/schemas/LoanAppStartedTestEvent0'
                  loan_app_updated: '#/components/schemas/LoanAppUpdatedTestEvent0'
                  loan_app_submitted: '#/components/schemas/LoanAppSubmittedTestEvent0'
                  loan_app_imported: '#/components/schemas/LoanAppImportedTestEvent0'
                  loan_app_abandoned: '#/components/schemas/LoanAppAbandonedTestEvent0'
                  document_uploaded: '#/components/schemas/DocumentUploadedTestEvent0'
                  document_created: '#/components/schemas/DocumentCreatedTestEvent0'
                  document_updated: '#/components/schemas/DocumentUpdatedTestEvent0'
                  loan_milestone_updated: '#/components/schemas/LoanMilestoneUpdatedTestEvent0'
                  loan_milestone_completed: '#/components/schemas/LoanMilestoneCompletedTestEvent0'
                  loan_created: '#/components/schemas/LoanCreatedTestEvent0'
                  loan_updated: '#/components/schemas/LoanUpdatedTestEvent0'
                  loan_deleted: '#/components/schemas/LoanDeletedTestEvent0'
                  loan_activated: '#/components/schemas/LoanActivatedTestEvent0'
                  loan_deactivated: '#/components/schemas/LoanDeactivatedTestEvent0'
                  milestones_reordered: '#/components/schemas/MilestonesReorderedTestEvent0'
                  milestone_created: '#/components/schemas/MilestoneCreatedTestEvent0'
                  milestone_deleted: '#/components/schemas/MilestoneDeletedTestEvent0'
                  organization_created: '#/components/schemas/OrganizationCreatedTestEvent0'
                  organization_deleted: '#/components/schemas/OrganizationDeletedTestEvent0'
                  state_license_created: '#/components/schemas/StateLicenseCreatedTestEvent0'
                  state_license_updated: '#/components/schemas/StateLicenseUpdatedTestEvent0'
                  state_license_deleted: '#/components/schemas/StateLicenseDeletedTestEvent0'
                  account_assignment_created: '#/components/schemas/AccountAssignmentCreatedTestEvent0'
                  account_assignment_deleted: '#/components/schemas/AccountAssignmentDeletedTestEvent0'
                  loan_officer_promoted: '#/components/schemas/LoanOfficerPromotedTestEvent0'
                  loan_officer_demoted: '#/components/schemas/LoanOfficerDemotedTestEvent0'
                  user_created: '#/components/schemas/UserCreatedTestEvent0'
                  user_updated: '#/components/schemas/UserUpdatedTestEvent0'
                  user_enabled: '#/components/schemas/UserEnabledTestEvent0'
                  user_disabled: '#/components/schemas/UserDisabledTestEvent0'
                  user_first_login: '#/components/schemas/UserFirstLoginTestEvent0'
                  user_deleted: '#/components/schemas/UserDeletedTestEvent0'
                  verification_available: '#/components/schemas/VerificationAvailableTestEvent0'
      security:
      - OAuth2: []
  /webhooks/{webhook_id}/actions:
    servers:
    - url: https://api.ncinomortgage.com
      description: Production server
    post:
      tags:
      - Webhooks
      operationId: webhooks-actions
      parameters:
      - name: webhook_id
        description: Webhook ID.
        required: true
        in: path
        schema:
          type: string
          format: uuid
      - $ref: '#/components/parameters/ApiVersionHeader'
      responses:
        '204':
          description: No content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoContent'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/ApiVersionResponseHeader'
            X-Api-Supported-Versions:
              $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
        '201':
          description: Created <<glossary:asynchronous job>> to process action
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceCreated'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/ApiVersionResponseHeader'
            X-Api-Supported-Versions:
              $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
        '409':
          description: Webhook already exists for the given URL
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSet'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/ApiVersionResponseHeader'
            X-Api-Supported-Versions:
              $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
        '412':
          description: Resource is in an invalid state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSet'
          headers:
            X-Api-Version:
              $ref: '#/components/headers/ApiVersionResponseHeader'
            X-Api-Supported-Versions:
              $ref: '#/components/headers/ApiSupportedVersionsResponseHeader'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      description: "> \U0001F4CC Available actions\n  **ENABLE** - Activate webhook\n  **DISABLE** - Deactivate webhook\n  **TEST** - Test webhook connection to URL\n  **CHANGE_URL** - Change URL for webhook"
      summary: Perform action on a webhook
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/WebhookAction'
              discriminator:
                propertyName: action
                mapping:
                  ENABLE: '#/components/schemas/WebhookAction'
                  DISABLE: '#/components/schemas/WebhookAction'
                  TEST: '#/components/schemas/WebhookAction'
                  CHANGE_URL: '#/components/schemas/ChangeUrlAction'
      security:
      - OAuth2: []
components:
  schemas:
    UserDeletedEventInfo:
      allOf:
      - $ref: '#/components/schemas/UserEventInfo'
      description: The event info particular to the user_deleted event.
    UserFirstLoginEventInfo:
      allOf:
      - $ref: '#/components/schemas/UserEventInfo'
      description: The event info particular to the user_first_login event.
    edit_webhook_configuration_post:
      type: object
      description: All fields are optional; only the fields included in the request body are updated.
      properties:
        name:
          type: string
          example: My integration webhook
        url:
          type: string
          example: https://example.com/webhooks/evault
        enabled:
          type: boolean
          example: true
        signingKey:
          type: string
          example: s3cr3t-signing-key
        sendEmailOnError:
          type: boolean
          example: false
        events:
          type: array
          items:
            $ref: '#/components/schemas/webhook_event_group'
    webhook_event_setting:
      type: object
      properties:
        key:
          type: string
          description: A webhook event you can subscribe to, used as the `key` of each entry in a webhook configuration's `events` array (enable an event by setting its `value` to true). A parent key (for example `change_data`, `change_status`, `connectivity`, `delivery`, `inquiry`, `registration`, `transfer`) enables every event in that group.
          enum:
          - archive_document
          - change_type
          - delete_document
          - download_doc
          - edit_document
          - reactivate_document
          - upload_document
          - add_enote_additional_data_point
          - became_authoritative_copy
          - delete_enote_additional_data_point
          - dtd_validation
          - data_validation
          - inquiry_validation
          - manual_archive
          - released_authoritative_copy
          - tamperseal_validation
          - update_enote_additional_data_point
          - upload_enote
          - view_enote_presentation
          - view_enote_xml
          - view_enote_data
          - change_data
          - add_document
          - add_secured_party
          - assumption
          - modification_electronic
          - modification_paper
          - release_secured_party
          - reverse_secured_party
          - update_rightsholders
          - change_data_notification
          - change_status
          - assumption_reversal
          - charged_off
          - charged_off_reversal
          - converted_to_paper
          - converted_to_paper_reversal
          - document_reversal
          - modification_reversal
          - paid_off
          - paid_off_reversal
          - paper_replacement
          - paper_replacement_reversal
          - registration_reversal
          - transferred_to_proprietary_registry
          - transferred_to_proprietary_registry_reversal
          - change_status_notification
          - connectivity
          - eDelivery_connectivity
          - eRegistry_connectivity
          - edelivery_connectivity_notification
          - eregistry_connectivity_notification
          - controller_history
          - delivery
          - delivery_accepted
          - delivery_approved
          - delivery_canceled
          - delivery_disapproved
          - delivery_distributed
          - delivery_expired
          - delivery_initiated
          - delivery_rejected
          - delivery_accepted_notification
          - delivery_approved_notification
          - delivery_disapproved_notification
          - delivery_distributed_notification
          - delivery_expired_notification
          - delivery_initiated_notification
          - delivery_rejected_notification
          - inquiry
          - contact_inquiry
          - member_inquiry
          - registration
          - registration_notification
          - resend_notifications
          - transfer
          - transfer_accepted
          - transfer_completed
          - transfer_expired
          - transfer_initiated
          - transfer_rejected
          - transfer_reset
          - transfer_completed_notification
          - transfer_expired_notification
          - transfer_initiated_notification
          - transfer_rejected_notification
          example: upload_document
        display_name:
          type: string
          example: Upload document
        value:
          type: boolean
          description: Whether this event type is enabled for the webhook configuration.
          example: false
        children:
          type: array
          items:
            type: object
          example: []
    OrganizationCreatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - organization_created
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - $ref: '#/components/schemas/OrganizationCreatedEventInfo'
      required:
      - event
      - event_info
      description: Available properties for testing a 'organization_created' event.
      additionalProperties: false
    UserUpdatedEventInfo:
      allOf:
      - $ref: '#/components/schemas/UserEventInfo'
      description: The event info particular to the user_updated event.
    AccountAssignmentEventInfo:
      type: object
      properties:
        assignee_type:
          type: string
          description: Type of the account that owns the assignment.
        assignee_name:
          type: string
          description: Name of the account that owns the assignment.
        assignor_type:
          type: string
          description: Type of entity the relevant account has access to.
        assignor_name:
          type: string
          description: Name of the entity the relevant account has access to.
      required:
      - assignee_type
      - assignee_name
      - assignor_type
      - assignor_name
      description: The event info particular to the account assignment events.
    UserDeletedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - user_deleted
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - $ref: '#/components/schemas/UserDeletedEventInfo'
      required:
      - event
      - event_info
      description: Available properties for testing a 'user_deleted' event.
      additionalProperties: false
    WebhookPagination:
      allOf:
      - $ref: '#/components/schemas/AbstractPagination'
      - type: object
        properties:
          contents:
            type: array
            items:
              $ref: '#/components/schemas/Webhook'
        required:
        - contents
    MilestoneDeletedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - milestone_deleted
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - $ref: '#/components/schemas/MilestoneDeletedEventInfo'
      required:
      - event
      - event_info
      description: Available properties for testing a 'milestone_deleted' event.
      additionalProperties: false
    StateLicenseUpdatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - state_license_updated
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - $ref: '#/components/schemas/StateLicenseEventInfo'
      required:
      - event
      - event_info
      description: Available properties for testing a 'state_license_updated' event.
      additionalProperties: false
    LoanActivatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_activated
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - $ref: '#/components/schemas/LoanEventInfo'
      required:
      - event
      - event_info
      description: Available properties for testing a 'loan_activated' event.
      additionalProperties: false
    MilestoneDeletedEventInfo:
      type: object
      properties:
        name:
          type: string
          description: Name of the organization.
      required:
      - name
      description: The event info particular to the milestone_deleted event.
    NationwideCode:
      type: string
      enum:
      - US
      description: Nationwide code.
    VerificationAvailableTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - verification_available
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - $ref: '#/components/schemas/VerificationAvailableEventInfo'
      required:
      - event
      - event_info
      description: Available properties for testing a 'verification_available' event.
      additionalProperties: false
    WebhookPostBody:
      type: object
      properties:
        url:
          type: string
          format: http_uri
          description: Webhook's callback URL.
        name:
          type: string
          description: Webhook's name.
        version:
          type: string
          description: API version to be used when webhook request is rendered.
          nullable: true
      required:
      - url
      - name
      description: Available properties for creating a webhook.
      additionalProperties: false
    LoanAppImportedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_app_imported
          description: Event that triggered the webhook.
        event_info:
 

# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ncino/refs/heads/main/openapi/ncino-webhooks-api-openapi.yml