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

# FinWatch Webhook

> Receives webhook events and processes transactions automatically. Configure this endpoint as your webhook URL to have transactions automatically forwarded to FinWatch for evaluation.



## OpenAPI

````yaml POST /blnkwebhook
openapi: 3.1.0
info:
  title: FinWatch API
  description: >-
    FinWatch REST API for real-time transaction monitoring, rule evaluation, and
    instruction management.
  version: 1.0.0
  contact:
    name: FinWatch Support
    url: https://docs.finwatch.finance
servers:
  - url: http://localhost:8081
    description: Local development server
security: []
tags:
  - name: Transactions
    description: >-
      Inject transactions for evaluation, retrieve transaction details, and
      handle webhook events.
  - name: Instructions
    description: >-
      Create, list, retrieve, and delete monitoring rules written in
      Watchscript.
  - name: Git
    description: Manage rules with Git for version control — status, pull, push, and clone.
paths:
  /blnkwebhook:
    post:
      tags:
        - Transactions
      summary: FinWatch Webhook
      description: >-
        Receives webhook events and processes transactions automatically.
        Configure this endpoint as your webhook URL to have transactions
        automatically forwarded to FinWatch for evaluation.
      operationId: blnkWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookRequest'
            example:
              event: transaction.created
              data:
                transaction_id: txn_123
                amount: 1000
                currency: USD
                source: balance_123
                destination: balance_456
                reference: ref_001
                status: applied
                created_at: '2024-01-15T10:30:00Z'
                meta_data:
                  key: value
      responses:
        '200':
          description: Webhook processed successfully
          content:
            text/plain:
              schema:
                type: string
                example: >-
                  Transaction txn_123 from webhook event 'transaction.created'
                  processed successfully
        '400':
          description: Invalid webhook payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    WebhookRequest:
      type: object
      required:
        - event
        - data
      properties:
        event:
          type: string
          description: The webhook event type (e.g., transaction.created)
        data:
          $ref: '#/components/schemas/Transaction'
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
        code:
          type: string
          description: Error code
    Transaction:
      type: object
      properties:
        transaction_id:
          type: string
          description: Unique transaction identifier
        amount:
          type: number
          format: double
          description: Transaction amount
        currency:
          type: string
          description: Currency code
        source:
          type: string
          description: Source balance identifier
        destination:
          type: string
          description: Destination balance identifier
        reference:
          type: string
          description: Unique reference identifier
        description:
          type: string
          description: Transaction description
        status:
          type: string
          description: Transaction status
        created_at:
          type: string
          format: date-time
          description: Creation timestamp
        meta_data:
          type: object
          additionalProperties: true
          description: Additional metadata

````