WireBloomDevelopers

    IntegratorEvent

    Schema #/components/schemas/IntegratorEvent of contract 1.0.0-draft.14.

    • id Uuidrequired

    • type IntegratorEventTyperequired

    • createdAt Timestamprequired

    • apiVersion stringrequired

    • tenantId Uuidrequired

    • data objectrequired

      Thin payload: fetch the full resource with the API (GET /payments/{id} …) using the id.

      Fields of data

      • object stringrequired

        One of: "payment", "transfer", "exchange", "incoming_payment", "recipient", "approval", "funds_request", "statement", "balance", "customer", "compliance_hold"

      • id Uuidrequired

      • status string | null

      • previousStatus string | null

      • amount Money | null

      • test boolean

        true on POST /integrator-webhooks/{webhookId}/test events (also header WireBloom-Test: true).

      • sandbox boolean

        true on events simulated through /sandbox/*.

      • related object

        compliance_hold.*: the held payment or incoming payment.

        Fields of related

        • object stringrequired

          One of: "payment", "incoming_payment"

        • id Uuidrequired

    • customerId Uuid | null