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

# Trigger Test Webhook

> Queue a synthetic `test` event for a single webhook registration. Access requires a machine API key with `webhooks:write` scope for the bound organization. The webhook must be active and subscribed to `test`.



## OpenAPI

````yaml /openapi.json post /v1/webhooks/{webhookId}/test
openapi: 3.1.0
info:
  title: Waycore Bank Connections API
  description: >-
    Developer-first API for direct bank connections, accounts, and transactions.


    Design goals:

    - Flat records with minimal nesting.

    - Clear, bank-centric naming.

    - One canonical endpoint per resource.

    - Sparse fieldsets via `fields=`.

    - Historical browsing via `GET /transactions`.

    - Incremental ETL via `GET /transactions/sync`.

    - Discover supported institutions via `GET /institutions`.

    - Model downstream client businesses via `/entities` and explicit `entityId`
    ownership.


    Authentication:

    - Opaque API keys passed as `Authorization: Bearer <key>`.

    - Key format: `way_<environment>_<key_id>_<secret>`.

    - Keys are organization-bound, environment-bound (`live` or `test`),
    scope-carrying, and expiring.

    - Managed via the Waycore Console.
  version: 0.5.0
servers:
  - url: https://api.waycore.com
security: []
paths:
  /v1/webhooks/{webhookId}/test:
    post:
      tags:
        - webhooks
      summary: Trigger Test Webhook
      description: >-
        Queue a synthetic `test` event for a single webhook registration. Access
        requires a machine API key with `webhooks:write` scope for the bound
        organization. The webhook must be active and subscribed to `test`.
      operationId: trigger_test_webhook_v1_webhooks__webhookId__test_post
      parameters:
        - name: webhookId
          in: path
          required: true
          schema:
            type: string
            title: Webhookid
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TriggerWebhookTestResponse'
        '400':
          description: >-
            Bad Request. `type` may be `invalid_request` for malformed request
            bodies, query parameters, path parameters, or validation failures.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
          description: Not Found
        '409':
          description: >-
            Conflict. Returned when the webhook is inactive or is not subscribed
            to the requested event.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
        '429':
          description: >-
            Too Many Requests. Retry after the number of seconds in
            `Retry-After` when present, then retry the same request.
          headers:
            Retry-After:
              description: >-
                Number of seconds to wait before retrying, when rate limiting
                provides a specific backoff.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
          description: Internal Server Error
      security:
        - apiKeyBearer:
            - webhooks:write
components:
  schemas:
    TriggerWebhookTestResponse:
      properties:
        webhookId:
          type: string
          title: Webhookid
          description: Identifier of the webhook whose test event was queued.
        meta:
          $ref: '#/components/schemas/app__webhooks__public__models__Meta'
      type: object
      required:
        - webhookId
        - meta
      title: TriggerWebhookTestResponse
    PublicErrorResponse:
      properties:
        type:
          title: Type
          type: string
        message:
          type: string
          title: Message
        requestId:
          anyOf:
            - type: string
            - type: 'null'
          title: Requestid
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
      type: object
      required:
        - type
        - message
      title: PublicErrorResponse
    app__webhooks__public__models__Meta:
      properties:
        requestId:
          type: string
          title: Requestid
          description: Request identifier for support and debugging.
      type: object
      required:
        - requestId
      title: Meta
  securitySchemes:
    apiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: way_<environment>_<key_id>_<secret>
      description: >-
        Opaque API key passed as `Authorization: Bearer <key>`. Keys are
        organization-bound, environment-bound (`live` or `test`),
        scope-carrying, and expiring. Create and manage keys via the console.

````