customers.create.event.schema.json

{
  "$id": "https://schemas.tillhub.com/v0/customers.create.event.schema.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "The webhook data set",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "webhook_id": {
      "description": "The webhook UUID",
      "example": "ff30cfdf-5167-4f72-b4fc-c1d72db3c07e",
      "type": "string",
      "format": "uuid"
    },
    "event_id": {
      "description": "The event UUID",
      "example": "c6fe918a-7bdc-4ccd-af36-95c03853233d",
      "type": "string",
      "format": "uuid"
    },
    "event_entity": {
      "description": "The entity name the event refers to",
      "example": "customer",
      "type": "string"
    },
    "event_type": {
      "description": "The event type (e.g. create, update, delete)",
      "example": "create",
      "type": "string"
    },
    "event_version": {
      "description": "The event payload version",
      "example": 0,
      "type": "number"
    },
    "entity_instance_id": {
      "description": "The entity instance UUID",
      "example": "10b06f38-031d-4e0c-8706-0474c8c5b61c",
      "type": "string",
      "format": "uuid"
    },
    "timestamp": {
      "description": "The date and time event was received by webhooks service",
      "example": "2024-04-26T15:02:03.944Z",
      "type": "string",
      "format": "date-time"
    },
    "payload": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "Unique entity ID",
          "type": "string",
          "format": "uuid",
          "example": "936835f7-2d75-41d2-9001-38ed6e458328"
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "example": "2019-03-17T21:12:04.849Z",
          "description": "The date and time entity was created"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "example": "2019-03-17T21:12:04.849Z",
          "description": "The date and time entity was updated"
        },
        "active": {
          "description": "Customer active",
          "example": "true",
          "type": "boolean",
          "default": true
        },
        "deleted": {
          "description": "Customer deleted",
          "type": "boolean",
          "default": false
        },
        "firstname": {
          "description": "First name",
          "example": "Boba",
          "anyOf": [
            {
              "type": "string",
              "maxLength": 128
            },
            {
              "type": "null"
            }
          ]
        },
        "lastname": {
          "example": "Fett",
          "description": "Last name",
          "anyOf": [
            {
              "type": "string",
              "maxLength": 128
            },
            {
              "type": "null"
            }
          ]
        },
        "middlename": {
          "description": "Middle name",
          "example": "Alpha",
          "anyOf": [
            {
              "type": "string",
              "maxLength": 128
            },
            {
              "type": "null"
            }
          ]
        },
        "displayname": {
          "description": "Display name",
          "example": "Boba F.",
          "anyOf": [
            {
              "type": "string",
              "maxLength": 32,
              "minLength": 3
            },
            {
              "type": "null"
            }
          ]
        },
        "phonenumbers": {
          "description": "Phone numbers",
          "example": {
            "main": "+49-555-123-4567"
          },
          "anyOf": [
            {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "main": {
                  "type": "string"
                },
                "home": {
                  "type": "string"
                },
                "mobile": {
                  "type": "string"
                },
                "work": {
                  "type": "string"
                }
              },
              "anyOf": [
                {
                  "required": [
                    "main"
                  ]
                },
                {
                  "required": [
                    "home"
                  ]
                },
                {
                  "required": [
                    "mobile"
                  ]
                },
                {
                  "required": [
                    "work"
                  ]
                }
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "email": {
          "description": "Email address",
          "example": "boba@kamino.empire",
          "anyOf": [
            {
              "type": "string",
              "maxLength": 128,
              "format": "email"
            },
            {
              "type": "null"
            }
          ],
          "default": null
        },
        "customer_number": {
          "description": "Unique customer number",
          "example": "fett-002",
          "anyOf": [
            {
              "type": "string",
              "maxLength": 128,
              "minLength": 1
            },
            {
              "type": "null"
            }
          ]
        },
        "company": {
          "description": "Company name",
          "example": {
            "name": "Bounty Hunter's Guild"
          },
          "anyOf": [
            {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "name": {
                  "anyOf": [
                    {
                      "type": "string",
                      "maxLength": 64
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "description": {
          "description": "Description",
          "example": "Bounty hunter",
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "is_b2b": {
          "description": "Is B2B customer",
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "date_of_birth": {
          "description": "Birth date",
          "anyOf": [
            {
              "type": "string",
              "format": "date-time"
            },
            {
              "type": "null"
            }
          ]
        },
        "images": {
          "description": "Images object with URLs of various types of images",
          "anyOf": [
            {
              "type": "object",
              "additionalProperties": true,
              "properties": {
                "1x": {
                  "description": "Image transformed to predefined small size",
                  "example": "https://my-storage.io/images/f5a3cc72-7fb5-4d2c-bda5-9b2983c7e879_1x.png",
                  "type": "string",
                  "format": "uri"
                },
                "2x": {
                  "description": "Image transformed to predefined medium size",
                  "example": "https://my-storage.io/images/f5a3cc72-7fb5-4d2c-bda5-9b2983c7e879_2x.png",
                  "type": "string",
                  "format": "uri"
                },
                "3x": {
                  "description": "Image transformed to predefined big size",
                  "example": "https://my-storage.io/images/f5a3cc72-7fb5-4d2c-bda5-9b2983c7e879_1x.png",
                  "type": "string",
                  "format": "uri"
                },
                "avatar": {
                  "description": "Image transformed to predefined size to use as \"avatar\"",
                  "example": "https://my-storage.io/images/f5a3cc72-7fb5-4d2c-bda5-9b2983c7e879_avatar.png",
                  "type": "string",
                  "format": "uri"
                },
                "gallery": {
                  "description": "Image transformed to predefined size to use in gallery",
                  "example": "https://my-storage.io/images/f5a3cc72-7fb5-4d2c-bda5-9b2983c7e879_gallery.png",
                  "type": "string",
                  "format": "uri"
                },
                "original": {
                  "description": "Original image",
                  "example": "https://my-storage.io/images/f5a3cc72-7fb5-4d2c-bda5-9b2983c7e879.png",
                  "type": "string",
                  "format": "uri"
                }
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "image": {
          "description": "DEPRECATED. Omit or set null.",
          "anyOf": [
            {
              "type": "object",
              "additionalProperties": true,
              "properties": {
                "1x": {
                  "type": "string",
                  "format": "uri"
                },
                "avatar": {
                  "oneOf": [
                    {
                      "type": "string",
                      "format": "uri"
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "contacts": {
          "description": "Contact info",
          "anyOf": [
            {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "email": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "enabled": {
                      "type": "boolean"
                    }
                  }
                },
                "newsletter": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "enabled": {
                      "type": "boolean"
                    }
                  }
                },
                "phone": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "enabled": {
                      "type": "boolean"
                    }
                  }
                },
                "post": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "enabled": {
                      "type": "boolean"
                    }
                  }
                }
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "metadata": {
          "description": "Additional metadata",
          "type": "object"
        },
        "addresses": {
          "description": "Addresses",
          "anyOf": [
            {
              "type": "array",
              "maxItems": 3,
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "lines",
                  "street",
                  "street_number",
                  "locality",
                  "region",
                  "postal_code",
                  "country",
                  "type"
                ],
                "properties": {
                  "lines": {
                    "description": "Address details",
                    "example": "Penthouse",
                    "oneOf": [
                      {
                        "type": "array",
                        "minItems": 1,
                        "maxItems": 4,
                        "items": {
                          "type": "string",
                          "minLength": 1
                        }
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "street": {
                    "description": "Street name",
                    "example": "Genthiner Str.",
                    "oneOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "street_number": {
                    "description": "Building number",
                    "example": "34",
                    "oneOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "locality": {
                    "description": "Locality name (city, village, etc.)",
                    "example": "Berlin",
                    "oneOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "region": {
                    "description": "Region name",
                    "example": "Branderburg",
                    "oneOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "postal_code": {
                    "description": "Postal code",
                    "example": "10785",
                    "oneOf": [
                      {
                        "type": "string",
                        "maxLength": 10
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "country": {
                    "description": "Country",
                    "example": "Germany",
                    "oneOf": [
                      {
                        "type": "string",
                        "minLength": 2,
                        "maxLength": 2,
                        "pattern": "^[A-Z]{2}$"
                      },
                      {
                        "type": "null"
                      }
                    ],
                    "default": null
                  },
                  "type": {
                    "description": "Address type",
                    "example": "delivery",
                    "oneOf": [
                      {
                        "type": "string",
                        "enum": [
                          "delivery",
                          "billing"
                        ]
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                }
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "custom": {
          "description": "Custom data",
          "anyOf": [
            {
              "type": "object"
            },
            {
              "type": "null"
            }
          ]
        },
        "comment": {
          "description": "Comment",
          "example": "Don't mess with",
          "anyOf": [
            {
              "type": "string",
              "maxLength": 1024
            },
            {
              "type": "null"
            }
          ]
        },
        "discounts": {
          "description": "Available discounts",
          "anyOf": [
            {
              "type": "array",
              "minItems": 1,
              "maxItems": 10,
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                      "id": {
                        "type": "string",
                        "maxLength": 128
                      },
                      "amount": {
                        "type": "number",
                        "minimum": 0
                      },
                      "type": {
                        "type": "string",
                        "enum": [
                          "percentage",
                          "value"
                        ]
                      },
                      "account": {
                        "anyOf": [
                          {
                            "type": "string",
                            "maxLength": 128
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "name": {
                        "anyOf": [
                          {
                            "type": "string",
                            "maxLength": 64
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "group": {
                        "type": "string",
                        "enum": [
                          "cart",
                          "customer"
                        ]
                      }
                    },
                    "required": [
                      "group",
                      "type",
                      "name",
                      "amount",
                      "id"
                    ]
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                      "amount": {
                        "type": "number",
                        "minimum": 0
                      },
                      "type": {
                        "type": "string",
                        "enum": [
                          "percent",
                          "percentage",
                          "value"
                        ]
                      },
                      "group": {
                        "type": "string",
                        "enum": [
                          "cart",
                          "customer"
                        ]
                      },
                      "name": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "amount",
                      "type",
                      "group"
                    ]
                  }
                ]
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "client_id": {
          "description": "Client ID",
          "anyOf": [
            {
              "type": "string",
              "maxLength": 128
            },
            {
              "type": "null"
            }
          ]
        },
        "external_reference": {
          "description": "External reference",
          "anyOf": [
            {
              "type": "string",
              "minLength": 3,
              "maxLength": 128
            },
            {
              "type": "null"
            }
          ]
        },
        "customer_since": {
          "description": "Customer since",
          "anyOf": [
            {
              "type": "string",
              "format": "date-time"
            },
            {
              "type": "null"
            }
          ]
        },
        "locations": {
          "description": "Locations customer belongs to",
          "oneOf": [
            {
              "type": "array",
              "items": {
                "type": "string",
                "format": "uuid"
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "branch_groups": {
          "description": "Branch groups customer belongs to",
          "oneOf": [
            {
              "type": "array",
              "items": {
                "type": "string",
                "format": "uuid"
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "gender": {
          "description": "Gender",
          "example": "male",
          "oneOf": [
            {
              "type": "string",
              "enum": [
                "male",
                "female",
                "unspecified"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "vat_id": {
          "description": "Customer VAT ID",
          "oneOf": [
            {
              "type": "string",
              "maxLength": 20,
              "minLength": 5
            },
            {
              "type": "null"
            }
          ]
        },
        "source": {
          "description": "Customer source of creation",
          "example": "N/A, DASHBOARD, APPOINTMENT_CALENDAR, WEB_RESERVATION, POS",
          "oneOf": [
            {
              "type": "string",
              "maxLength": 128
            },
            {
              "type": "null"
            }
          ]
        },
        "branch_id": {
          "description": "in cases where the customer is created via the POS, the branch_id is required",
          "oneOf": [
            {
              "type": "string",
              "format": "uuid"
            },
            {
              "type": "null"
            }
          ]
        },
        "price_book": {
          "description": "in cases where the customer is going to have personal pricebook (like for discounts in pharmacy by personal insurance number), price_book is required",
          "oneOf": [
            {
              "type": "string",
              "format": "uuid"
            },
            {
              "type": "null"
            }
          ]
        },
        "insert_id": {
          "description": "Sequential customer index",
          "type": "integer"
        },
        "customer_group": {
          "description": "Deprecated: The group of customer",
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "price_list": {
          "description": "Price list",
          "oneOf": [
            {
              "type": "object"
            },
            {
              "type": "null"
            }
          ]
        },
        "delegated_to": {
          "description": "Entries customer delegated to",
          "oneOf": [
            {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "owner": {
          "description": "Deprecated: Owner",
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      }
    }
  }
}