nCino

nCino Webhooks API

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

GitHub OpenAPI

Operations 11

PUT /webhooks Create a webhook configuration #
POST /webhooks Create a new webhook record #
GET /webhooks Retrieve all webhook records #
GET /webhooks/{webhook_id} Get a webhook configuration #
POST /webhooks/{webhook_id} Edit a webhook configuration #
DELETE /webhooks/{webhook_id} Delete a webhook configuration #
PATCH /webhooks/{webhook_id} Update a webhook record #
POST /webhooks/{webhook_id}/active-status Update a webhook configuration's active status #
POST /webhooks/{webhook_id}/test Test a webhook configuration #
POST /webhooks/{webhook_id}/test_events Perform test event on a webhook #
POST /webhooks/{webhook_id}/actions Perform action on a webhook #

Documentation

📖
Documentation
https://developer.ncinomortgage.com/mortgage/docs/getting-started
📖
APIReference
https://developer.ncinomortgage.com/mortgage/reference
📖
Authentication
https://developer.ncinomortgage.com/mortgage/docs/authentication-1
📖
Documentation
https://developer.ncinomortgage.com/mortgage/docs/webhooks
📖
Documentation
https://developer.ncino.com/e-vault/docs/getting-started
📖
APIReference
https://developer.ncino.com/e-vault/reference
📖
Authentication
https://developer.ncino.com/e-vault/docs/authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ncino/refs/heads/main/openapi/ncino-webhooks-api-openapi.yml

Other Resources

🔗
Postman
https://api.ncinomortgage.com/developer_info/postman_collection/1.0
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/ncino/refs/heads/main/asyncapi/ncino-mortgage-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/ncino-webhooks-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

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:
    ResourceCreated:
      allOf:
      - $ref: '#/components/schemas/AbstractResourceModel'
      description: Resource created model
    ErrorSet:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      required:
      - errors
      example:
        errors:
        - id: 123abc
          status: 400
          title: Generic title for the error
          detail: Detailed message for the error
          _links:
            resource: contextual resource if applicable
    LoanUpdatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_updated
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - $ref: '#/components/schemas/LoanEventInfo'
      required:
      - event
      - event_info
      description: Available properties for testing a 'loan_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
    AbstractResourceModel:
      allOf:
      - $ref: '#/components/schemas/AbstractModel'
      - type: object
        properties:
          id:
            type: string
            format: uuid
            description: Unique identifier for the record.
        required:
        - id
        additionalProperties: false
    webhook_event_group:
      type: object
      properties:
        name:
          type: string
          example: Electronic records
        settings:
          type: array
          items:
            $ref: '#/components/schemas/webhook_event_setting'
    LoanAppStartedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_app_started
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - $ref: '#/components/schemas/LoanApplicationEventInfo'
      required:
      - event
      - event_info
      description: Available properties for testing a 'loan_app_started' event.
      additionalProperties: false
    UserUpdatedEventInfo:
      allOf:
      - $ref: '#/components/schemas/UserEventInfo'
      description: The event info particular to the user_updated event.
    LoanOfficerPromotedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_officer_promoted
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - $ref: '#/components/schemas/LoanOfficerAdminChangeEventInfo'
      required:
      - event
      - event_info
      description: Available properties for testing a 'loan_officer_promoted' event.
      additionalProperties: false
    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'
    UserDeletedEventInfo:
      allOf:
      - $ref: '#/components/schemas/UserEventInfo'
      description: The event info particular to the user_deleted event.
    WebhookPagination:
      allOf:
      - $ref: '#/components/schemas/AbstractPagination'
      - type: object
        properties:
          contents:
            type: array
            items:
              $ref: '#/components/schemas/Webhook'
        required:
        - contents
    UserDisabledEventInfo:
      allOf:
      - $ref: '#/components/schemas/UserEventInfo'
      description: The event info particular to the user_disabled event.
    LoanAppAbandonedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_app_abandoned
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - $ref: '#/components/schemas/LoanApplicationEventInfo'
      required:
      - event
      - event_info
      description: Available properties for testing a 'loan_app_abandoned' event.
      additionalProperties: false
    AbstractModel:
      type: object
      properties:
        _self:
          type: string
          description: The model's resource link to itself.
        _type:
          type: string
          description: The model's type.
        _links:
          type: object
          description: A list of links for the model's associations.
      required:
      - _self
      - _type
      additionalProperties: false
    default_success_response:
      type: object
      properties:
        success:
          type: boolean
          example: true
        errors:
          type: array
          nullable: true
          items:
            type: string
          example: null
        warnings:
          type: array
          nullable: true
          items:
            type: string
          example: null
    NullableJobStatus:
      type: string
      enum:
      - QUEUED
      - STARTED
      - QUEUED_FOR_RETRY
      - COMPLETED
      - FAILED
      - null
      nullable: true
    DocumentUploadedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - document_uploaded
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - $ref: '#/components/schemas/DocumentUploadedEventInfo'
      required:
      - event
      - event_info
      description: Available properties for testing a 'document_uploaded' event.
      additionalProperties: false
    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
    UserDisabledTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - user_disabled
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - $ref: '#/components/schemas/UserDisabledEventInfo'
      required:
      - event
      - event_info
      description: Available properties for testing a 'user_disabled' event.
      additionalProperties: false
    AbstractPagination:
      allOf:
      - $ref: '#/components/schemas/AbstractCollection'
      - type: object
        properties:
          total_pages:
            type: integer
            description: The total number of pages in the collection.
          total:
            type: integer
            description: The total number of items in the collection.
        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
    DocumentCreatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - document_created
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - $ref: '#/components/schemas/DocumentCreatedEventInfo'
      required:
      - event
      - event_info
      description: Available properties for testing a 'document_created' event.
      additionalProperties: false
    LoanDeactivatedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
          - loan_deactivated
          description: Event that triggered the webhook.
        event_info:
          allOf:
          - $ref: '#/components/schemas/LoanEventInfo'
      required:
      - event
      - event_info
      description: Available properties for testing a 'loan_deactivated' 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
    AccountAssignmentDeletedTestEvent0:
      type: object
      properties:
        event:
          type: string
          enum:
         

# --- 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