Payload examples

These are examples of product update webhook payloads. Please also refer to the OpenAPI specification.

Customer Product Update

{
  "product_code": "PRCODE-GB",
  "old_state": {
    "price_multiplier": "0.9"
  },
  "new_state": {
    "price_multiplier": "0.8"
  },
  "timestamp": "2024-04-10T17:11:26.601254"
}

OpenAPI specification

openapi: 3.1.0
info:
  title: webhooks
  description: |-
    The webhooks Runa sends to notify you of events.
  version: 1.0.0
externalDocs:
  description: Runa webhook guide
  url: https://developer.runa.io/docs/webhooks
webhooks:
  product-update:
    post:
      requestBody:
        description: Information about an updated product
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ProductUpdate"
      responses:
        "200":
          description: Return a 200 status to indicate that the data was received successfully
components:
  schemas:
    ProductUpdate:
      type: object
      properties:
        product_code:
          type: string
          example: "PRCODE-GB"
        old_state:
          $ref: "#/components/schemas/ProductState"
        new_state:
          $ref: "#/components/schemas/ProductState"
        timestamp:
          type: string
          example: "2024-04-10T17:11:26.601254"
      required:
        - product_code
        - new_state
        - timestamp
    ProductState:
      type: object
      properties:
        price_multiplier:
          type: string
          example: "0.8"