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

# Simulate Interac webhook (non-production)

> Sends a mock Interac collection webhook to your configured collection_url. Only available outside production; returns 400 in production. Required scope: `mock:webhook:trigger`.



## OpenAPI

````yaml /api-reference/mock/simulate-webhook-interac-openapi.json post /api/external/mock/simulate-webhook/interac
openapi: 3.1.0
info:
  title: Blaaiz Platform API - Mock Interac Webhook
  version: 1.0.0
  description: >-
    Simulate an Interac collection webhook to your configured collection_url.
    Available only in non-production environments.
servers:
  - url: https://api-prod.blaaiz.com
  - url: https://api-dev.blaaiz.com
security: []
tags:
  - name: Webhook
paths:
  /api/external/mock/simulate-webhook/interac:
    post:
      tags:
        - Webhook
      summary: Simulate Interac webhook (non-production)
      description: >-
        Sends a mock Interac collection webhook to your configured
        collection_url. Only available outside production; returns 400 in
        production. Required scope: `mock:webhook:trigger`.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimulateInteracRequest'
            example:
              interac_email: customer@example.com
              collection_name: John Doe
              amount: 100.5
      responses:
        '200':
          description: Webhook sent successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulateInteracResponse'
              example:
                message: Webhook sent successfully
        '400':
          description: Unavailable in production or missing configuration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: This endpoint is only available in development environment
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: Invalid or missing access token
      security:
        - oauth2ClientCredentials:
            - mock:webhook:trigger
components:
  schemas:
    SimulateInteracRequest:
      type: object
      properties:
        interac_email:
          type: string
          format: email
          description: Sender email to include in source_information.collection_email.
        collection_name:
          type: string
          description: Sender name to include in source_information.collection_name.
        amount:
          type: number
          description: Optional amount for the simulated Interac transaction.
    SimulateInteracResponse:
      type: object
      properties:
        message:
          type: string
      required:
        - message
    Error:
      type: object
      properties:
        message:
          type: string
      required:
        - message
  securitySchemes:
    oauth2ClientCredentials:
      type: oauth2
      description: >-
        Use your OAuth client credentials to obtain a short-lived Bearer token
        from POST /oauth/token.
      flows:
        clientCredentials:
          tokenUrl: /oauth/token
          scopes:
            mock:webhook:trigger: Trigger mock webhook simulations.

````