openapi: 3.1.0
info:
  title: Gift Card Webhooks API
  version: 1.0.0
  description: Webhooks to notify events related to Gift Cards

webhooks:
  CancelGiftCard:
    post:
      summary: Triggered when a gift card or credit note is cancelled
      description: Triggered when a gift card or credit note is cancelled
      operationId: CancelGiftCard
      requestBody:
        description: The payload of the Cancel Gift Card event
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  $ref: '#/components/schemas/GiftCard_Export'
                  description: The event data
                meta:
                  type: object
                  description: The event metadata
                  properties:
                    apiVersion:
                      type: string
                      description: The API version
                      enum: [3.0.252900]
              required:
                - meta
      responses:
        "200":
          description: Data was received successfully
        "400":
          description: Bad Request
components:
  schemas:
    GiftCard_Export:
      type: object
      description: Instances of Gift Cards
      properties:
        client:
          type: string
          description: Client search key
          maxLength: 40
        organization:
          type: string
          description: Organization name
          maxLength: 32