openapi: 3.2.0
info:
  title: Webhooks API
  version: '0'
  description: Studio webhooks
servers:
- url: https://sandbox.bond.tech/api/v0.1
security:
- identity: []
  authorization: []
tags:
- name: Webhooks
paths:
  /webhooks:
    post:
      summary: Create webhook subscription
      description: Subscribe to webhook events
      operationId: post_webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/webhook-post'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhook'
              examples:
                example:
                  value:
                    webhook_subscription:
                      id: 487a7f29-7b80-467d-b20d-7b60c3a14cf0
                      url: https://hostname.com/webhook/route
                      description: KYC state changes.
                      events:
                      - kyc.verification.success
                      - kyc.verification.failure
                      - kyc.verification.kba
                      - kyc.verification.error
                      - kyc.verification.timeout
                      version: '0.1'
                      secret: whsec_ira5jceuzhxxBxoWckAU0hLFQe79bSMZ
                      status: STATUS_ENABLED
                      creted_time: '2022-06-09T18:23:37.585421Z'
                      updated_time: '2022-06-09T18:23:37.585421Z'
      tags:
      - Webhooks
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook_subscriptions:
                    type: array
                    items:
                      $ref: '#/components/schemas/all-webhooks'
      summary: Get all webhook subscriptions
      description: Retrieves a list of all webhook subscriptions
      operationId: get_webhooks
      tags:
      - Webhooks
  /webhooks/{webhook_id}:
    patch:
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhook'
              examples:
                example:
                  value:
                    webhook_subscription:
                      id: 487a7f29-7b80-467d-b20d-7b60c3a14cf0
                      url: https://hostname.com/webhook/route
                      description: KYC state changes.
                      events:
                      - kyc.verification.success
                      - kyc.verification.failure
                      - kyc.verification.kba
                      - kyc.verification.error
                      - kyc.verification.timeout
                      version: '0.1'
                      secret: whsec_ira5jceuzhxxBxoWckAU0hLFQe79bSMZ
                      status: STATUS_ENABLED
                      creted_time: '2022-06-09T18:23:37.585421Z'
                      updated_time: '2022-06-09T18:23:37.585421Z'
      summary: Update a webhook subscription
      description: Updates a webhook subscription
      operationId: patch_webhooks
      parameters:
      - name: webhook_id
        in: path
        required: true
        description: Webhook ID
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/webhook-patch'
        required: true
      tags:
      - Webhooks
    delete:
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhook'
              examples:
                example:
                  value:
                    webhook_subscription:
                      id: 487a7f29-7b80-467d-b20d-7b60c3a14cf0
                      url: https://hostname.com/webhook/route
                      description: KYC state changes.
                      events:
                      - kyc.verification.success
                      - kyc.verification.failure
                      - kyc.verification.kba
                      - kyc.verification.error
                      - kyc.verification.timeout
                      version: '0.1'
                      secret: whsec_ira5jceuzhxxBxoWckAU0hLFQe79bSMZ
                      status: STATUS_ENABLED
                      creted_time: '2022-06-09T18:23:37.585421Z'
                      updated_time: '2022-06-09T18:23:37.585421Z'
      summary: Remove a webhook subscription
      description: Deletes a webhook subscription
      operationId: delete_webhooks
      parameters:
      - name: webhook_id
        in: path
        required: true
        description: Webhook ID
        schema:
          type: string
      tags:
      - Webhooks
components:
  schemas:
    webhook:
      x-examples:
        webhook:
          webhook_subscription:
            id: 487a7f29-7b80-467d-b20d-7b60c3a14cf0
            url: https://hostname.com/webhook/route
            description: KYC state changes.
            events:
            - kyc.verification.success
            - kyc.verification.failure
            - kyc.verification.kba
            - kyc.verification.error
            - kyc.verification.timeout
            version: '0.1'
            secret: whsec_ira5jceuzhxxBxoWckAU0hLFQe79bSMZ
            status: STATUS_ENABLED
            creted_time: '2022-06-09T18:23:37.585421Z'
            updated_time: '2022-06-09T18:23:37.585421Z'
      title: webhook
      description: ''
      type: object
      properties:
        webhook_subscription:
          type: object
          properties:
            id:
              type: string
              example: 487a7f29-7b80-467d-b20d-7b60c3a14cf0
              description: uuid of webhook
            url:
              type: string
              description: Webhook callback URL
              example: https://hostname.com/webhook/route
            description:
              type: string
              description: Optional description of the webhook's intended use
              example: KYC state changes.
            events:
              type: array
              description: List of events enabled in the webhook subscription
              items:
                type: string
                enum:
                - account.history.ready
                - card.created
                - card.status.active
                - card.status.closed
                - card.status.inactive
                - card.status.reissue
                - card.wallet.add
                - card.wallet.add_failure
                - credit.application.created
                - credit.application.submitted
                - credit.application.approved
                - credit.application.adverse_action
                - credit.application.resubmit_required
                - customer.updated
                - develop.api_key.created
                - kyb.verification.approved
                - kyb.verification.error
                - kyb.verification.initiated
                - kyb.verification.rejected
                - kyb.verification.warning
                - kyb.verification.under_review
                - kyc.verification.document_required
                - kyc.verification.error
                - kyc.verification.failure
                - kyc.verification.reenter_information
                - kyc.verification.success
                - kyc.verification.timeout
                - kyc.verification.under_review
                - portal.data_export
                - transactions
            version:
              type: string
              example: '0.1'
              description: version of webhook event envelope
            secret:
              type: string
            status:
              type: string
              example: enabled
              enum:
              - enabled
              - disabled
              description: status of webhook. `enabled` or `disabled`
            creted_time:
              type: string
              example: '2022-06-09T18:23:37.585421Z'
            updated_time:
              type: string
              example: '2022-06-09T18:23:37.585421Z'
    webhook-patch:
      type: object
      x-examples:
        webhook:
          id: 487a7f29-7b80-467d-b20d-7b60c3a14cf0
          url: https://hostname.com/webhook/route
          description: KYC state changes.
          events:
          - kyc.verification.success
          - kyc.verification.failure
          - kyc.verification.kba
          - kyc.verification.error
          - kyc.verification.timeout
          version: '0.1'
          secret: ''
          status: enabled
        secret-revealed:
          id: 487a7f29-7b80-467d-b20d-7b60c3a14cf0
          url: https://hostname.com/webhook/route
          description: KYC state changes.
          events:
          - kyc.verification.success
          - kyc.verification.failure
          - kyc.verification.kba
          - kyc.verification.error
          - kyc.verification.timeout
          version: '0.1'
          secret: whsec_XqTEJtniwuEhp0A1c1cTJNsmpR/qgOfB
          status: enabled
          creted_time: '2022-06-09T18:23:37.585421Z'
          updated_time: '2022-06-09T18:23:37.585421Z'
      title: webhook-patch
      description: ''
      properties:
        url:
          type: string
          description: Webhook callback URL
          example: https://hostname.com/webhook/route
        description:
          type: string
          description: Optional description of the webhook's intended use
          example: KYC state changes.
        events:
          type: array
          description: List of events enabled in the webhook subscription
          items:
            type: string
            enum:
            - account.autopay.failed
            - account.autopay.processed
            - account.autopay.scheduled
            - account.history.ready
            - account.statements.generated
            - account.statements.ready
            - card.created
            - card.status.active
            - card.status.closed
            - card.status.inactive
            - card.status.reissue
            - card.wallet.add
            - card.wallet.add_failure
            - credit.application.created
            - credit.application.submitted
            - credit.application.approved
            - credit.application.adverse_action
            - credit.application.resubmit_required
            - develop.api_key.created
            - kyb.verification.approved
            - kyb.verification.error
            - kyb.verification.initiated
            - kyb.verification.rejected
            - kyb.verification.warning
            - kyb.verification.under_review
            - kyc.verification.document_required
            - kyc.verification.error
            - kyc.verification.failure
            - kyc.verification.reenter_information
            - kyc.verification.success
            - kyc.verification.timeout
            - kyc.verification.under_review
            - portal.data_export
            - transactions
        version:
          type: string
          example: '0.1'
          description: version of webhook event envelope
        status:
          type: string
          description: status of webhook. `enabled` or `disabled`
          enum:
          - STATUS_ENABLED
          - STATUS_DISABLED
          example: STATUS_ENABLED
    all-webhooks:
      x-examples:
        webhook:
          webhook_subscription:
            id: 487a7f29-7b80-467d-b20d-7b60c3a14cf0
            url: https://hostname.com/webhook/route
            description: KYC state changes.
            events:
            - kyc.verification.success
            - kyc.verification.failure
            - kyc.verification.kba
            - kyc.verification.error
            - kyc.verification.timeout
            version: '0.1'
            secret: whsec_ira5jceuzhxxBxoWckAU0hLFQe79bSMZ
            status: STATUS_ENABLED
            creted_time: '2022-06-09T18:23:37.585421Z'
            updated_time: '2022-06-09T18:23:37.585421Z'
      title: all-webhook
      description: ''
      type: object
      properties:
        id:
          type: string
          example: 487a7f29-7b80-467d-b20d-7b60c3a14cf0
          description: uuid of webhook
        url:
          type: string
          description: Webhook callback URL
          example: https://hostname.com/webhook/route
        description:
          type: string
          description: Optional description of the webhook's intended use
          example: KYC state changes.
        events:
          type: array
          description: List of events enabled in the webhook subscription
          items:
            type: string
            enum:
            - account.autopay.failed
            - account.autopay.processed
            - account.autopay.scheduled
            - account.history.ready
            - account.statements.generated
            - account.statements.ready
            - card.created
            - card.status.active
            - card.status.closed
            - card.status.inactive
            - card.status.reissue
            - card.wallet.add
            - card.wallet.add_failure
            - credit.application.created
            - credit.application.submitted
            - credit.application.approved
            - credit.application.adverse_action
            - credit.application.resubmit_required
            - develop.api_key.created
            - kyb.verification.approved
            - kyb.verification.error
            - kyb.verification.initiated
            - kyb.verification.rejected
            - kyb.verification.warning
            - kyb.verification.under_review
            - kyc.verification.document_required
            - kyc.verification.error
            - kyc.verification.failure
            - kyc.verification.reenter_information
            - kyc.verification.success
            - kyc.verification.timeout
            - kyc.verification.under_review
            - portal.data_export
            - transactions
        version:
          type: string
          example: '0.1'
          description: version of webhook event envelope
        secret:
          type: string
        status:
          type: string
          example: enabled
          enum:
          - enabled
          - disabled
          description: status of webhook. `enabled` or `disabled`
        creted_time:
          type: string
          example: '2022-06-09T18:23:37.585421Z'
        updated_time:
          type: string
          example: '2022-06-09T18:23:37.585421Z'
    webhook-post:
      type: object
      x-examples:
        webhook:
          id: 487a7f29-7b80-467d-b20d-7b60c3a14cf0
          url: https://hostname.com/webhook/route
          description: KYC state changes.
          events:
          - kyc.verification.success
          - kyc.verification.failure
          - kyc.verification.kba
          - kyc.verification.error
          - kyc.verification.timeout
          version: '0.1'
          secret: ''
          status: enabled
          creted_time: '2022-06-09T18:23:37.585421Z'
          updated_time: '2022-06-09T18:23:37.585421Z'
        secret-revealed:
          id: 487a7f29-7b80-467d-b20d-7b60c3a14cf0
          url: https://hostname.com/webhook/route
          description: KYC state changes.
          events:
          - kyc.verification.success
          - kyc.verification.failure
          - kyc.verification.kba
          - kyc.verification.error
          - kyc.verification.timeout
          version: '0.1'
          secret: whsec_XqTEJtniwuEhp0A1c1cTJNsmpR/qgOfB
          status: enabled
          creted_time: '2022-06-09T18:23:37.585421Z'
          updated_time: '2022-06-09T18:23:37.585421Z'
      title: webhook-post
      description: ''
      properties:
        url:
          type: string
          description: Webhook callback URL
          example: https://hostname.com/webhook/route
        description:
          type: string
          description: Optional description of the webhook's intended use
          example: KYC state changes.
        events:
          type: array
          description: List of events enabled in the webhook subscription
          items:
            type: string
            enum:
            - account.autopay.failed
            - account.autopay.processed
            - account.autopay.scheduled
            - account.history.ready
            - account.statements.generated
            - account.statements.ready
            - card.created
            - card.status.active
            - card.status.closed
            - card.status.inactive
            - card.status.reissue
            - card.wallet.add
            - card.wallet.add_failure
            - credit.application.created
            - credit.application.submitted
            - credit.application.approved
            - credit.application.adverse_action
            - credit.application.resubmit_required
            - develop.api_key.created
            - kyb.verification.approved
            - kyb.verification.error
            - kyb.verification.initiated
            - kyb.verification.rejected
            - kyb.verification.warning
            - kyb.verification.under_review
            - kyc.verification.document_required
            - kyc.verification.error
            - kyc.verification.failure
            - kyc.verification.reenter_information
            - kyc.verification.success
            - kyc.verification.timeout
            - kyc.verification.under_review
            - portal.data_export
            - transactions
        version:
          type: string
          example: '0.1'
          description: version of webhook event envelope
        status:
          type: string
          example: STATUS_ENABLED
          description: status of webhook. `enabled` or `disabled`
          enum:
          - STATUS_ENABLED
          - STATUS_DISABLED
      required:
      - url
      - events
  securitySchemes:
    identity:
      type: apiKey
      in: header
      name: Identity
    authorization:
      type: apiKey
      in: header
      name: Authorization
x-samples-languages:
- curl
- node
- ruby
- javascript
- python
- csharp
- java
x-provenance:
  method: searched
  source: https://docs.bond.tech/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.bond.tech/reference/delete_webhooks.md
  - https://docs.bond.tech/reference/get_webhooks.md
  - https://docs.bond.tech/reference/patch_webhooks.md
  - https://docs.bond.tech/reference/post_webhooks.md
  merge:
    pages: 4
    deduped: 8
    conflicts_kept_first: 0