Company

Payloads for available company events. Company webhooks fire when companies or their associated notes are created, modified, or removed in the Mimeeq CRM.

Company Created

The company-created event is triggered when a new company is created. The payload includes the full company record at the time of creation — address, account details, delivery addresses, social links, payment terms, and tags.

Payload example

{
  "id": "COMP-efd45129-cb8e-4b82-81d9-2a8cb1feba0f",
  "companyName": "Example Company",
  "customerId": "CUST-2920178e-143b-4d67-b713-d6fb93b2a65c",
  "status": "ACTIVE",
  "address": {
    "street": "123 Example Street",
    "city": "Example City",
    "postcode": "12345",
    "country": "Example Country"
  },
  "accountDetails": {
    "workNumber": "123-456-7890",
    "email": "[email protected]"
  },
  "deliveryAddresses": [
    {
      "name": "Delivery Address 1",
      "street": "456 Example Street",
      "city": "Example City",
      "postcode": "12345",
      "country": "Example Country",
      "companyName": "Example Company"
    }
  ],
  "socials": [
    {
      "type": "linkedin",
      "address": "https://www.linkedin.com/company/example"
    }
  ],
  "paymentTerms": "30 days",
  "currency": "USD",
  "tags": ["tag1", "tag2"]
}

Payload fields

Field	Type	Description
id	string	Company identifier (e.g., "COMP-...")
companyName	string	Display name of the company
customerId	string	Mimeeq customer (tenant) identifier
status	string	Company status — "ACTIVE" or "INACTIVE"
address	Address	Primary company address
accountDetails	AccountDetails	Contact information for the company account
deliveryAddresses	DeliveryAddress[]	List of registered delivery addresses
socials	Social[]	Social media links (e.g., LinkedIn, Twitter)
paymentTerms	string | null	Payment terms (e.g., "30 days")
currency	string	Default currency code for this company (e.g., "USD")
tags	string[]	Tags assigned to the company for categorisation

---

Company Updated

The company-updated event is triggered when changes are made to an existing company. The payload contains the full company record after the update — not a diff. Compare with previous state on your side if you need to detect which fields changed.

Payload example

{
  "id": "COMP-efd45129-cb8e-4b82-81d9-2a8cb1feba0f",
  "companyName": "Updated Company",
  "customerId": "CUST-2920178e-143b-4d67-b713-d6fb93b2a65c",
  "status": "INACTIVE",
  "address": {
    "street": "456 Updated Street",
    "city": "Updated City",
    "postcode": "54321",
    "country": "Updated Country"
  },
  "accountDetails": {
    "workNumber": "098-765-4321",
    "email": "[email protected]"
  },
  "deliveryAddresses": [
    {
      "name": "Updated Delivery Address",
      "street": "789 Updated Street",
      "city": "Updated City",
      "postcode": "54321",
      "country": "Updated Country",
      "companyName": "Updated Company"
    }
  ],
  "socials": [
    {
      "type": "twitter",
      "address": "https://www.twitter.com/updated_company"
    }
  ],
  "paymentTerms": "60 days",
  "currency": "EUR",
  "tags": ["updatedTag1", "updatedTag2"]
}

The payload fields are the same as Company Created.

---

Company Deleted

The company-deleted event is triggered when a company is removed. The payload contains only the identifiers needed to locate and clean up the record in your external system.

Payload example

{
  "id": "COMP-efd45129-cb8e-4b82-81d9-2a8cb1feba0f",
  "companyName": "Example Company",
  "customerId": "CUST-2920178e-143b-4d67-b713-d6fb93b2a65c"
}

Payload fields

Field	Type	Description
id	string	Company identifier of the deleted company
companyName	string	Display name at time of deletion
customerId	string	Mimeeq customer (tenant) identifier

---

Company Note Created

The company-note-created event is triggered when a new note is attached to a company's record. Notes can include text content and file attachments.

Payload example

{
  "id": "826399cc-9270-4b76-bdfa-dda1a9b2caf0",
  "companyId": "COMP-d1172465-44c5-4dba-851d-12cc7ad2b423",
  "companyName": "Example Company",
  "customerId": "CUST-ae8ccd26-59f6-4af3-82aa-54376fd58f42",
  "note": {
    "id": "826399cc-9270-4b76-bdfa-dda1a9b2caf0",
    "title": "Example Note Title",
    "content": "Example Note Content",
    "attachments": [
      {
        "name": "Example Attachment Name",
        "path": "https://example.com/attachment"
      }
    ]
  }
}

Payload fields

Field	Type	Description
id	string	Note identifier (same as note.id)
companyId	string	Company this note belongs to
companyName	string	Display name of the company
customerId	string	Mimeeq customer (tenant) identifier
note	Note	The note object with title, content, and attachments

Note

Field	Type	Description
id	string	Note identifier
title	string	Note title
content	string	Note body text (empty string if no content)
attachments	Attachment[]	Files attached to the note

Attachment

Field	Type	Description
name	string	File name of the attachment
path	string	CDN URL to download the file

---

Company Note Updated

The company-note-updated event is triggered when an existing note on a company's record is updated. The payload contains the full note after the update.

Payload example

{
  "id": "826399cc-9270-4b76-bdfa-dda1a9b2caf0",
  "companyId": "COMP-d1172465-44c5-4dba-851d-12cc7ad2b423",
  "companyName": "Example Company",
  "customerId": "CUST-ae8ccd26-59f6-4af3-82aa-54376fd58f42",
  "note": {
    "id": "826399cc-9270-4b76-bdfa-dda1a9b2caf0",
    "title": "Updated Note Title",
    "content": "Updated Note Content",
    "attachments": [
      {
        "name": "Updated Attachment Name",
        "path": "https://example.com/updated_attachment"
      }
    ]
  }
}

The payload fields are the same as Company Note Created.

---

Company Note Deleted

The company-note-deleted event is triggered when a note linked to a company is removed. Only identifiers are included — the note content is no longer available.

Payload example

{
  "id": "826399cc-9270-4b76-bdfa-dda1a9b2caf0",
  "companyId": "COMP-d1172465-44c5-4dba-851d-12cc7ad2b423",
  "companyName": "Example Company",
  "customerId": "CUST-ae8ccd26-59f6-4af3-82aa-54376fd58f42"
}

Payload fields

Field	Type	Description
id	string	Identifier of the deleted note
companyId	string	Company the note belonged to
companyName	string	Display name of the company
customerId	string	Mimeeq customer (tenant) identifier