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

# Test webhook endpoint

> Sends a test delivery of the chosen event type to the endpoint,
regardless of its event subscriptions. Provide `financial_account_id`
to build the payload from one of your accounts where possible;
otherwise sample data is sent.



## OpenAPI

````yaml /openapi/v1.json post /webhooks/{webhookEndpointId}/test
openapi: 3.2.0
info:
  title: Synci
  version: '1.0'
  description: >-
    Synci is a platform for integrating financial accounts with your favorite
    apps.
servers:
  - url: https://api.synci.io/api/v1
security:
  - oauth2: []
  - http: []
tags:
  - name: Finance
    kind: nav
  - name: Connections
    parent: Finance
  - name: Accounts
    parent: Finance
  - name: Transactions
    parent: Finance
  - name: Institutions
    parent: Finance
  - name: Destinations
    kind: nav
  - name: YNAB
    parent: Destinations
  - name: Lunch Money
    parent: Destinations
  - name: Google Sheets
    parent: Destinations
  - name: SimpleFIN
    parent: Destinations
  - name: Notion
    parent: Destinations
  - name: Account
    kind: nav
  - name: Webhooks
    parent: Account
  - name: User
    parent: Account
  - name: rule-engine
    summary: Rules
    kind: nav
  - name: Rules
    parent: rule-engine
  - name: Rule Logs
    parent: rule-engine
  - name: Transfers
    kind: nav
  - name: Transfer Links
    parent: Transfers
  - name: Transfer Logs
    parent: Transfers
paths:
  /webhooks/{webhookEndpointId}/test:
    post:
      tags:
        - Webhooks
      summary: Test webhook endpoint
      description: |-
        Sends a test delivery of the chosen event type to the endpoint,
        regardless of its event subscriptions. Provide `financial_account_id`
        to build the payload from one of your accounts where possible;
        otherwise sample data is sent.
      operationId: webhooks.test
      parameters:
        - name: webhookEndpointId
          in: path
          required: true
          description: The webhook endpoint ID
          schema:
            type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestWebhookRequest'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    const: Webhook test event dispatched.
                required:
                  - message
        '401':
          $ref: '#/components/responses/AuthenticationException'
        '403':
          $ref: '#/components/responses/AuthorizationException'
        '404':
          $ref: '#/components/responses/ModelNotFoundException'
        '422':
          $ref: '#/components/responses/ValidationException'
components:
  schemas:
    TestWebhookRequest:
      type: object
      properties:
        financial_account_id:
          type:
            - integer
            - 'null'
          description: |-
            Optional financial account to build the test payload from.
            When omitted, sample data is sent instead.
        event:
          $ref: '#/components/schemas/WebhookEventTypeEnum'
          description: The event type to send to the endpoint.
      required:
        - event
      title: TestWebhookRequest
    WebhookEventTypeEnum:
      type: string
      description: >
        Webhook event types Synci can emit. The three account-lifecycle events
        were renamed from `bank_account.*` to `account.*`, and the payload embed
        key from `bank_account` to `financial_account`. The legacy
        `bank_account.*` event names remain available so existing integrations
        keep working — endpoints with `payload_version=v1` receive the legacy
        variant.  The other events (`transactions.*`, `balance.updated`,
        `holdings.updated`) have the same event-type string in both versions;
        only the payload embed key differs between v1 and v2.
      enum:
        - transactions.created
        - transactions.updated
        - balance.updated
        - holdings.updated
        - account.created
        - account.updated
        - account.deleted
        - bank_account.created
        - bank_account.updated
        - bank_account.deleted
        - connection.created
        - connection.activated
        - connection.reauthorized
        - connection.expiring
        - connection.expired
        - connection.failing
        - connection.recovered
        - connection.disabled
        - connection.deleted
        - portal.user.verified
      title: WebhookEventTypeEnum
  responses:
    AuthenticationException:
      description: Unauthenticated
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
    AuthorizationException:
      description: Authorization error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
    ModelNotFoundException:
      description: Not found
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
    ValidationException:
      description: Validation error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Errors overview.
              errors:
                type: object
                description: A detailed description of each field that failed validation.
                additionalProperties:
                  type: array
                  items:
                    type: string
            required:
              - message
              - errors
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://api.synci.io/oauth/authorize
          tokenUrl: https://api.synci.io/oauth/token
          scopes:
            profile:read: View your name, email, and profile details
            accounts:read: View your connected financial accounts and balances
            accounts:write: >-
              Update, sync, and remove your financial accounts, and change their
              settings
            transactions:read: View your transactions
            transactions:write: Create, update, and delete your transactions
            sensitive:read: >-
              See sensitive identifiers like account numbers and account holder
              names
            transfer-links:read: View your transfer links and their transfer history
            transfer-links:write: Create, update, and delete transfer links, and undo transfers
            rules:read: View your rules and rule activity
            rules:write: Create, update, and delete rules, and undo rule actions
            webhooks:read: View your webhook endpoints
            webhooks:write: >-
              Create, update, and delete webhook endpoints, and rotate their
              secrets
            destinations:read: View your connected destinations
            destinations:write: Connect, update, and remove destinations
            financial-connections:read: View your connected institutions
            financial-connections:write: Manage your connected institutions
    http:
      type: http
      description: Bearer token (personal access token or OAuth access token)
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.