These docs are for v2023-09-01. Click to read the latest docs for v2024-04-01.

Company Events

When subscribed to the Company webhooks you will receive the following events:

event_typedescription
company.updatedCompany has been updated
company.provisionedAdministrator has been granted access to the company
company.deprovisionedAdministrator has had access to the company removed
company.partner_authorized
company.migratedMigrate API call has been made for this company
company.approvedCompany has been approved
company.needs_approvalCompany status has changed from "Approved" to "Needs Approval"
(note: you will not receive this webhook for a request for information)
company.onboardedCompany has been onboarded

Example payload

{
  "uuid": "04a04afb-b212-42bc-8fe6-b7ce31bf304d",
  "event_type": "company.provisioned",
  "resource_type": "Company",
  "resource_uuid": "5df911a0-e8e9-412d-8aaf-a46ad193dd96",
  "entity_type": "Company",
  "entity_uuid": "5df911a0-e8e9-412d-8aaf-a46ad193dd96",
  "timestamp": 1671058841
}

In the case of Company Events, the resource_type, and resource_uuid, match the entity_type and entity_uuid.