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

# Send a test event

> Delivers a `webhook.test` event to this subscription synchronously (even when it is disabled) and returns the result of the single attempt: HTTP status, the first 2 KB of the response body and the error, if any. Test sends are signed like real events and are not retried.



## OpenAPI

````yaml /openapi/public-v1.json post /v1/webhooks/{id}/test
openapi: 3.0.0
info:
  title: NextLevel MCA Public API
  description: >-
    REST API for the NextLevel MCA deal platform. Objects flow Businesses →
    People → Deals → Submissions → Offers → Advances.


    **Authentication.** Send `Authorization: Bearer <key>` with an API key
    (`nlmca_live_…`, created in Settings → Developers) or an OAuth access token.
    Keys are scoped to one location.


    **Conventions.** JSON only. Cursor pagination (`limit` ≤ 100, `cursor` from
    `meta.next_cursor`). Every success is `{ data, meta }`; every error is `{
    error: { type, message, code, param, request_id } }`. POST endpoints accept
    `Idempotency-Key` (24h replay). Rate limit 300 requests/min per credential
    (`X-RateLimit-*` headers).


    **Scopes.** Keys with no scopes have all of them. Otherwise:

    - `businesses:read` — Read businesses and their notes, tasks and activity

    - `businesses:write` — Create and update businesses, notes and tasks

    - `people:read` — Read people (contacts and owners)

    - `people:write` — Create and update people

    - `deals:read` — Read deals, submissions and the pipeline

    - `deals:write` — Create and update deals, move stages

    - `documents:read` — Read documents and statement analysis

    - `documents:write` — Upload documents and request documents from merchants

    - `lenders:read` — Read lenders, criteria and lender matches

    - `lenders:write` — Create and update lenders and criteria

    - `submissions:write` — Submit deals to lenders and withdraw submissions

    - `offers:read` — Read offers

    - `offers:write` — Log and update offers, set the primary offer

    - `advances:read` — Read funded advances and renewal flags

    - `advances:write` — Update advances

    - `portal:send` — Generate and send merchant portal links

    - `webhooks:manage` — Manage webhook subscriptions
  version: '1.0'
  contact: {}
servers:
  - url: https://api.nextlevelmca.com
    description: Production
security:
  - bearer: []
tags:
  - name: Businesses
    description: Merchant businesses and their notes, tasks and activity
  - name: People
    description: Contacts and owners. Phone lookups normalise to E.164.
  - name: Deals
    description: Deals, stage moves, renewals and the pipeline
  - name: Documents
    description: Documents, presigned uploads, document requests and statement analysis
  - name: Lenders
    description: Lenders and their criteria
  - name: Lender matches
    description: Criteria-driven lender matching for a deal
  - name: Submissions
    description: Sending deals to lenders
  - name: Offers
    description: Lender offers and the primary offer
  - name: Advances
    description: Funded advances and renewal readiness
  - name: Merchant portal
    description: Magic links for the merchant portal
  - name: Webhooks
    description: Outbound event subscriptions
paths:
  /v1/webhooks/{id}/test:
    post:
      tags:
        - Webhooks
      summary: Send a test event
      description: >-
        Delivers a `webhook.test` event to this subscription synchronously (even
        when it is disabled) and returns the result of the single attempt: HTTP
        status, the first 2 KB of the response body and the error, if any. Test
        sends are signed like real events and are not retried.
      operationId: webhooks_test
      parameters:
        - name: id
          required: true
          in: path
          description: Subscription id
          schema:
            type: string
      responses:
        '200':
          description: Delivery attempted (check `data.status`)
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                properties:
                  data:
                    $ref: '#/components/schemas/WebhookTestResultDto'
                  meta:
                    $ref: '#/components/schemas/EmptyMetaDto'
        '401':
          description: Missing, invalid, expired or revoked credential.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelopeDto'
        '403':
          description: Credential lacks the scope, or the role lacks the permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelopeDto'
        '404':
          description: Resource not found in this location.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelopeDto'
        '429':
          description: Rate limit exceeded. See `X-RateLimit-*` and `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelopeDto'
      security:
        - bearer: []
components:
  schemas:
    WebhookTestResultDto:
      type: object
      properties:
        delivery_id:
          type: string
          description: >-
            Id of the delivery that was attempted (also sent as
            `X-NLMCA-Delivery`).
        event_type:
          type: string
          example: webhook.test
          description: Event type that was sent.
        status:
          type: string
          enum:
            - succeeded
            - dead
          description: >-
            `succeeded` when the endpoint answered 2xx within 10 seconds. Test
            sends are not retried.
        response_status:
          type: number
          nullable: true
          description: >-
            HTTP status returned by the endpoint, or `null` when the connection
            failed or timed out.
        response_body:
          type: string
          nullable: true
          description: First 2 KB of the response body.
        error:
          type: string
          nullable: true
          description: >-
            Failure reason, e.g. `Timed out after 10s` or `Endpoint responded
            with HTTP 500`.
        duration_ms:
          type: number
          description: Round-trip time of the attempt in milliseconds.
      required:
        - delivery_id
        - event_type
        - status
        - response_status
        - response_body
        - error
        - duration_ms
    EmptyMetaDto:
      type: object
      properties: {}
    ErrorEnvelopeDto:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/PublicErrorDto'
      required:
        - error
    PublicErrorDto:
      type: object
      properties:
        type:
          type: string
          enum:
            - validation_error
            - authentication_error
            - permission_error
            - not_found
            - conflict
            - rate_limit_error
            - api_error
        message:
          type: string
          description: Human-readable explanation, safe to show to an operator or an agent.
        code:
          type: string
          description: >-
            Stable machine-readable code, e.g. `missing_scope`,
            `duplicate_business`.
        param:
          type: string
          description: Request field the error refers to, when applicable.
        request_id:
          type: string
          description: Echo of the `X-Request-Id` header. Quote it when contacting support.
      required:
        - type
        - message
        - request_id
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: API key or JWT
      type: http
      description: API key (`nlmca_live_…`) or OAuth access token

````

## Related topics

- [Changelog](/changelog/changelog.md)
- [Webhooks](/guides/webhooks.md)
- [Create a webhook subscription](/api-reference/webhooks/create-a-webhook-subscription.md)
