Contact

Payloads for available contact events. Contact webhooks fire when contacts are created, modified, or removed in the Mimeeq CRM. Each contact belongs to a company and carries their own address, phone, email, and tagging data.

Contact Created

The contact-created event is triggered when a new contact is created. The payload includes the full contact record at the time of creation.

Payload example

{
  "id": "CONT-c1496051-94fb-44bb-b68f-2da8f5900e21",
  "customerId": "CUST-e3115ba6-0cce-4ba5-9803-aadf90ba2a96",
  "companyId": "COMP-ebf7b5c3-b50c-43a0-9d01-7ef5c25612ac",
  "firstName": "John",
  "lastName": "Doe",
  "status": "ACTIVE",
  "addressDetails": {
    "address": "123 Example Street",
    "city": "Example City",
    "zipCode": "12345",
    "country": "Example Country"
  },
  "phoneNumbers": [
    {
      "type": "PRIVATE",
      "number": "123-456-7890"
    }
  ],
  "emails": [
    {
      "type": "WORK",
      "mail": "[email protected]"
    }
  ],
  "tags": ["tag1", "tag2"]
}

Payload fields

Field	Type	Description
id	string	Contact identifier (e.g., "CONT-...")
customerId	string	Mimeeq customer (tenant) identifier
companyId	string	Company this contact belongs to
firstName	string	Contact's first name
lastName	string	Contact's last name
status	string	Contact status — "ACTIVE" or "INACTIVE"
addressDetails	AddressDetails	Contact's address
phoneNumbers	PhoneNumber[]	List of phone numbers with type labels
emails	Email[]	List of email addresses with type labels
tags	string[]	Tags assigned to the contact for categorisation

AddressDetails

Field	Type	Description
address	string | null	Street address
city	string | null	City
zipCode	string | null	Postal / ZIP code
country	string | null	Country

PhoneNumber

Field	Type	Description
type	string	Phone number category (e.g., "PRIVATE", "WORK")
number	string	The phone number

Email

Field	Type	Description
type	string	Email category (e.g., "WORK", "PRIVATE")
mail	string	The email address

---

Contact Updated

The contact-updated event is triggered when changes are made to an existing contact. The payload contains the full contact record after the update — not a diff. This event also includes accountDetails with role information when available.

Payload example

{
  "id": "CONT-c1496051-94fb-44bb-b68f-2da8f5900e21",
  "customerId": "CUST-e3115ba6-0cce-4ba5-9803-aadf90ba2a96",
  "companyId": "COMP-ebf7b5c3-b50c-43a0-9d01-7ef5c25612ac",
  "firstName": "John",
  "lastName": "Doe",
  "status": "ACTIVE",
  "addressDetails": {
    "address": "123 Example Street",
    "city": "Example City",
    "zipCode": "12345",
    "country": "Example Country"
  },
  "phoneNumbers": [
    {
      "type": "PRIVATE",
      "number": "123-456-7890"
    }
  ],
  "emails": [
    {
      "type": "WORK",
      "mail": "[email protected]"
    }
  ],
  "accountDetails": {
    "position": "Manager"
  },
  "tags": ["tag1", "tag2"]
}

The payload fields are the same as Contact Created, with one addition:

Field	Type	Description
accountDetails	AccountDetails | undefined	Contact's role information within the company

AccountDetails

Field	Type	Description
position	string | null	The contact's job title or position at the company

---

Contact Deleted

The contact-deleted event is triggered when a contact is removed. The payload contains only identifiers and email addresses — enough to locate and clean up the record in your external system.

Payload example

{
  "id": "CONT-c1496051-94fb-44bb-b68f-2da8f5900e21",
  "customerId": "CUST-e3115ba6-0cce-4ba5-9803-aadf90ba2a96",
  "emails": [
    {
      "type": "WORK",
      "mail": "[email protected]"
    }
  ]
}

Payload fields

Field	Type	Description
id	string	Contact identifier of the deleted contact
customerId	string	Mimeeq customer (tenant) identifier
emails	Email[]	Email addresses of the deleted contact, useful for cross-referencing in external systems