Organization Webhooks

Organization.Company.Created.V1

Triggered when a company is created in Organization

Status: ACTIVE  Origin: COMPANY

Payload Schema

{
  "type": "object",
  "properties": {
    "companyId": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string"
    },
    "businessName": {
      "type": "string"
    },
    "companyRegistrationNumber": {
      "type": "string"
    },
    "address": {
      "type": "object",
      "properties": {
        "street": {
          "type": "string",
          "nullable": true
        },
        "postalCode": {
          "type": "string",
          "nullable": true
        },
        "city": {
          "type": "string",
          "nullable": true
        }
      }
    },
    "organizationId": {
      "type": "string",
      "format": "uuid"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "companyId",
    "name",
    "companyRegistrationNumber",
    "organizationId",
    "timestamp"
  ]
}

Organization.Company.Updated.V1

Triggered when a company is updated in Organization

Status: ACTIVE  Origin: COMPANY

Payload Schema

{
  "type": "object",
  "properties": {
    "companyId": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string"
    },
    "businessName": {
      "type": "string"
    },
    "companyRegistrationNumber": {
      "type": "string"
    },
    "address": {
      "type": "object",
      "properties": {
        "street": {
          "type": "string",
          "nullable": true
        },
        "postalCode": {
          "type": "string",
          "nullable": true
        },
        "city": {
          "type": "string",
          "nullable": true
        }
      }
    },
    "status": {
      "type": "string"
    },
    "organizationId": {
      "type": "string",
      "format": "uuid"
    },
    "changes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "oldValue": {},
          "newValue": {}
        },
        "required": [
          "field"
        ]
      }
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "companyId",
    "name",
    "companyRegistrationNumber",
    "organizationId",
    "changes",
    "timestamp"
  ]
}