HRIS Webhook Data Schema

schema.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "hris_id": {
            "type": "string",
            "description": "An ID that uniquely identifies the user within your HRIS. You may also set this to the email address of the user if you don't have an HRIS ID available."
          },
          "first_name": {
            "type": "string"
          },
          "last_name": {
            "type": "string"
          },
          "email": {
            "type": "email"
          },
          "job_title": {
            "type": "string"
          },
          "phone_number": {
            "type": "string"
          },
          "employee_id": {
            "type": "string"
          },
          "profile_image": {
            "type": "object",
            "properties": {
              "url": {
                "type": "string"
              },
              "last_modified": {
                "type": "date-time"
              },
              "cache_info": {
                "type": "string"
              }
            },
            "required": [
              "url"
            ]
          },
          "departments": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "For sub-departments, use > to indicate the department is inside a larger department. Eg 'Engineering > Mobile Team'\n\n\nNew Departments:\n\nIf a department does not exist in 7Geese, it will be created."
            }
          },
          "active": {
            "type": "boolean"
          },
          "manager": {
            "type": "object",
            "properties": {
              "hris_id": {
                "type": "string"
              }
            },
            "required": [
              "hris_id"
            ]
          }
        },
        "required": [
          "active",
          "email",
          "hris_id",
          "first_name",
          "last_name"
        ]
      }
    }
  },
  "required": [
    "users"
  ]
}