Skip to content

Organization Webhooks

Triggered when a company is created in Organization

Status: ACTIVE  Origin: COMPANY

{
  "type": "object",
  "properties": {
    "event": {
      "type": "string",
      "enum": [
        "Organization.Company.Created.V1"
      ]
    },
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string"
    },
    "businessName": {
      "type": "string"
    },
    "companyRegistrationNumber": {
      "type": "string"
    },
    "countryCode": {
      "type": "string"
    },
    "currencyCode": {
      "type": "string"
    },
    "address": {
      "type": "object",
      "properties": {
        "street": {
          "type": "string",
          "nullable": true
        },
        "postalCode": {
          "type": "string",
          "nullable": true
        },
        "city": {
          "type": "string",
          "nullable": true
        }
      }
    },
    "locationIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "status": {
      "type": "string",
      "enum": [
        "Undefined",
        "Onboarding",
        "Offboarding",
        "Paused",
        "Active",
        "Readonly",
        "Locked"
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "event",
    "id",
    "name",
    "businessName",
    "companyRegistrationNumber",
    "countryCode",
    "currencyCode",
    "address",
    "locationIds",
    "status",
    "createdAt",
    "timestamp"
  ]
}

Triggered when a company is updated in Organization

Status: ACTIVE  Origin: COMPANY

{
  "type": "object",
  "properties": {
    "event": {
      "type": "string",
      "enum": [
        "Organization.Company.Updated.V1"
      ]
    },
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string"
    },
    "businessName": {
      "type": "string"
    },
    "companyRegistrationNumber": {
      "type": "string"
    },
    "countryCode": {
      "type": "string"
    },
    "currencyCode": {
      "type": "string"
    },
    "address": {
      "type": "object",
      "properties": {
        "street": {
          "type": "string",
          "nullable": true
        },
        "postalCode": {
          "type": "string",
          "nullable": true
        },
        "city": {
          "type": "string",
          "nullable": true
        }
      }
    },
    "locationIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "status": {
      "type": "string",
      "enum": [
        "Undefined",
        "Onboarding",
        "Offboarding",
        "Paused",
        "Active",
        "Readonly",
        "Locked"
      ]
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "changes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "oldValue": {},
          "newValue": {}
        },
        "required": [
          "field",
          "oldValue",
          "newValue"
        ]
      }
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "event",
    "id",
    "name",
    "businessName",
    "companyRegistrationNumber",
    "countryCode",
    "currencyCode",
    "address",
    "locationIds",
    "status",
    "updatedAt",
    "changes",
    "timestamp"
  ]
}

Triggered when a location is created in Organization

Status: ACTIVE  Origin: LOCATION

{
  "type": "object",
  "properties": {
    "event": {
      "type": "string",
      "enum": [
        "Organization.Location.Created.V1"
      ]
    },
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string"
    },
    "address": {
      "type": "object",
      "properties": {
        "street": {
          "type": "string"
        },
        "postalCode": {
          "type": "string"
        },
        "city": {
          "type": "string"
        }
      },
      "required": [
        "street",
        "postalCode",
        "city"
      ]
    },
    "coordinates": {
      "type": "object",
      "properties": {
        "latitude": {
          "type": "number"
        },
        "longitude": {
          "type": "number"
        }
      },
      "required": [
        "latitude",
        "longitude"
      ]
    },
    "countryCode": {
      "type": "string"
    },
    "timeZone": {
      "type": "string"
    },
    "locale": {
      "type": "string"
    },
    "companyId": {
      "type": "string",
      "format": "uuid"
    },
    "costCenter": {
      "type": "object",
      "nullable": true,
      "properties": {
        "name": {
          "type": "string",
          "nullable": true
        },
        "number": {
          "type": "string",
          "nullable": true
        }
      }
    },
    "status": {
      "type": "string",
      "enum": [
        "Undefined",
        "Onboarding",
        "Active",
        "Paused",
        "Offboarding"
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "event",
    "id",
    "name",
    "address",
    "coordinates",
    "countryCode",
    "timeZone",
    "locale",
    "companyId",
    "costCenter",
    "status",
    "createdAt",
    "timestamp"
  ]
}

Triggered when a location is updated in Organization

Status: ACTIVE  Origin: LOCATION

{
  "type": "object",
  "properties": {
    "event": {
      "type": "string",
      "enum": [
        "Organization.Location.Updated.V1"
      ]
    },
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string"
    },
    "address": {
      "type": "object",
      "properties": {
        "street": {
          "type": "string"
        },
        "postalCode": {
          "type": "string"
        },
        "city": {
          "type": "string"
        }
      },
      "required": [
        "street",
        "postalCode",
        "city"
      ]
    },
    "coordinates": {
      "type": "object",
      "properties": {
        "latitude": {
          "type": "number"
        },
        "longitude": {
          "type": "number"
        }
      },
      "required": [
        "latitude",
        "longitude"
      ]
    },
    "countryCode": {
      "type": "string"
    },
    "timeZone": {
      "type": "string"
    },
    "locale": {
      "type": "string"
    },
    "companyId": {
      "type": "string",
      "format": "uuid"
    },
    "costCenter": {
      "type": "object",
      "nullable": true,
      "properties": {
        "name": {
          "type": "string",
          "nullable": true
        },
        "number": {
          "type": "string",
          "nullable": true
        }
      }
    },
    "status": {
      "type": "string",
      "enum": [
        "Undefined",
        "Onboarding",
        "Active",
        "Paused",
        "Offboarding"
      ]
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "changes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "oldValue": {},
          "newValue": {}
        },
        "required": [
          "field",
          "oldValue",
          "newValue"
        ]
      }
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "event",
    "id",
    "name",
    "address",
    "coordinates",
    "countryCode",
    "timeZone",
    "locale",
    "companyId",
    "costCenter",
    "status",
    "updatedAt",
    "changes",
    "timestamp"
  ]
}

Triggered when an area is created in Organization

Status: ACTIVE  Origin: AREA

{
  "type": "object",
  "properties": {
    "event": {
      "type": "string",
      "enum": [
        "Organization.Area.Created.V1"
      ]
    },
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string"
    },
    "locationId": {
      "type": "string",
      "format": "uuid"
    },
    "parentAreaId": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "costCenter": {
      "type": "object",
      "nullable": true,
      "properties": {
        "name": {
          "type": "string",
          "nullable": true
        },
        "number": {
          "type": "string",
          "nullable": true
        }
      }
    },
    "status": {
      "type": "string",
      "enum": [
        "Undefined",
        "Active"
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "event",
    "id",
    "name",
    "locationId",
    "parentAreaId",
    "costCenter",
    "status",
    "createdAt",
    "timestamp"
  ]
}

Triggered when an area is updated in Organization

Status: ACTIVE  Origin: AREA

{
  "type": "object",
  "properties": {
    "event": {
      "type": "string",
      "enum": [
        "Organization.Area.Updated.V1"
      ]
    },
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string"
    },
    "locationId": {
      "type": "string",
      "format": "uuid"
    },
    "parentAreaId": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "costCenter": {
      "type": "object",
      "nullable": true,
      "properties": {
        "name": {
          "type": "string",
          "nullable": true
        },
        "number": {
          "type": "string",
          "nullable": true
        }
      }
    },
    "status": {
      "type": "string",
      "enum": [
        "Undefined",
        "Active"
      ]
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "changes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "oldValue": {},
          "newValue": {}
        },
        "required": [
          "field",
          "oldValue",
          "newValue"
        ]
      }
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "event",
    "id",
    "name",
    "locationId",
    "parentAreaId",
    "costCenter",
    "status",
    "updatedAt",
    "changes",
    "timestamp"
  ]
}