Contacts

This guide explains the Contact Webhook Payload data format for Contact Added, Contact Tag Added, and Contact Tag Removed triggers in Whautomate. Stay up-to-date and optimize your workflow today!

Contact Created

(i) Payload Format: Contact Created Payload data format and content that Whautomate will transmit to the configured endpoint.

{
  "event": {
    "id": "{{event.id}}",
    "type": "{{event.type}}",
    "timeStamp": "{{event.timeStamp}}",
    "key": "{{event.key}}"
  },
  "contact": {
    "id": "{{contact.id}}",
    "name": "{{contact.name}}",
    "channel": "{{contact.channel}}",
    "phoneNumber": "{{contact.phoneNumber}}",
    "username": "{{contact.username}}",
    "messengerId": "{{contact.messengerId}}",
    "telegramChatId": "{{contact.telegramChatId}}",
    "instagramId": "{{contact.instagramId}}",
    "lastActivity": "{{contact.lastActivity}}",
    "notes": "{{contact.notes}}",
    "stage": "{{contact.stage}}",
    "tags": "{{contact.tags}}",
    "customFields": "{{contact.customFields}}",
    "location": {
      "id": "{{contact.location.id}}",
      "title": "{{contact.location.title}}"
    },
    "createdAt": "{{contact.createdAt}}",
    "updatedAt": "{{contact.updatedAt}}"
  }
}

(ii) Contact Created test Payload data 👇

{
  "event": {
    "id": "ecKyX3x8IY",
    "type": "contact_created",
    "timeStamp": "2024-03-17T09:15:00Z",
    "key": "bXcgZ2xXbCU"
  },
  "contact": {
    "id": "bXcgZ2xXbCU",
    "name": "Alice Johnson",
    "channel": "Whatsapp",
    "phoneNumber": "[phone]",
    "lastActivity": "2024-03-16T15:30:00Z",
    "notes": "Interested in upcoming promotions",
    "stage": "Lead",
    "tags": "["Prospect","Interested"]",
    "customFields": "{"membership":"Silver","preferredLanguage":"English"}",
    "location": {
      "id": "LXhX3x8QYI",
      "title": "Main Office"
    },
    "createdAt": "2024-03-15T10:00:00Z",
    "updatedAt": "2024-03-17T11:45:00Z"
  }
}

---

Contact Tag Added

(i) Payload Format: Contact Tag Added Payload data format and content that Whautomate will transmit to the configured endpoint.

{
  "event": {
    "id": "{{event.id}}",
    "type": "{{event.type}}",
    "timeStamp": "{{event.timeStamp}}",
    "key": "{{event.key}}"
  },
  "contact": {
    "id": "{{contact.id}}",
    "name": "{{contact.name}}",
    "channel": "{{contact.channel}}",
    "phoneNumber": "{{contact.phoneNumber}}",
    "username": "{{contact.username}}",
    "messengerId": "{{contact.messengerId}}",
    "telegramChatId": "{{contact.telegramChatId}}",
    "instagramId": "{{contact.instagramId}}",
    "lastActivity": "{{contact.lastActivity}}",
    "notes": "{{contact.notes}}",
    "stage": "{{contact.stage}}",
    "tags": "{{contact.tags}}",
    "addedTags": "{{contact.addedTags}}",
    "customFields": "{{contact.customFields}}",
    "location": {
      "id": "{{contact.location.id}}",
      "title": "{{contact.location.title}}"
    },
    "createdAt": "{{contact.createdAt}}",
    "updatedAt": "{{contact.updatedAt}}"
  }
}

(ii) Contact Tag Added test Payload data 👇

{
  "event": {
    "id": "ecKyX3x8IY",
    "type": "contact_tag_added",
    "timeStamp": "2024-03-17T09:15:00Z",
    "key": "bXcgZ2xXbCU"
  },
  "contact": {
    "id": "bXcgZ2xXbCU",
    "name": "Alice Johnson",
    "channel": "Whatsapp",
    "phoneNumber": "[phone]",
    "lastActivity": "2024-03-16T15:30:00Z",
    "notes": "Interested in upcoming promotions",
    "stage": "Lead",
    "tags": "["Prospect","Interested"]",
    "addedTags": "["Interested"]",
    "customFields": "{"membership":"Silver","preferredLanguage":"English"}",
    "location": {
      "id": "LXhX3x8QYI",
      "title": "Main Office"
    },
    "createdAt": "2024-03-15T10:00:00Z",
    "updatedAt": "2024-03-17T11:45:00Z"
  }
}

---

Contact Tag Removed

(i) Payload Format: Contact Tag Removed Payload data format and content that Whautomate will transmit to the configured endpoint.

{
  "event": {
    "id": "{{event.id}}",
    "type": "{{event.type}}",
    "timeStamp": "{{event.timeStamp}}",
    "key": "{{event.key}}"
  },
  "contact": {
    "id": "{{contact.id}}",
    "name": "{{contact.name}}",
    "channel": "{{contact.channel}}",
    "phoneNumber": "{{contact.phoneNumber}}",
    "username": "{{contact.username}}",
    "messengerId": "{{contact.messengerId}}",
    "telegramChatId": "{{contact.telegramChatId}}",
    "instagramId": "{{contact.instagramId}}",
    "lastActivity": "{{contact.lastActivity}}",
    "notes": "{{contact.notes}}",
    "stage": "{{contact.stage}}",
    "tags": "{{contact.tags}}",
    "removedTags": "{{contact.removedTags}}",
    "customFields": "{{contact.customFields}}",
    "location": {
      "id": "{{contact.location.id}}",
      "title": "{{contact.location.title}}"
    },
    "createdAt": "{{contact.createdAt}}",
    "updatedAt": "{{contact.updatedAt}}"
  }
}

(ii) Contact Tag Removed test Payload data 👇

{
  "event": {
    "id": "ecKyX3x8IY",
    "type": "contact_tag_removed",
    "timeStamp": "2024-03-17T09:15:00Z",
    "key": "bXcgZ2xXbCU"
  },
  "contact": {
    "id": "bXcgZ2xXbCU",
    "name": "Alice Johnson",
    "channel": "Whatsapp",
    "phoneNumber": "[phone]",
    "lastActivity": "2024-03-16T15:30:00Z",
    "notes": "Interested in upcoming promotions",
    "stage": "Lead",
    "tags": "["Interested"]",
    "removedTags": "["Prospect"]",
    "customFields": "{"membership":"Silver","preferredLanguage":"English"}",
    "location": {
      "id": "LXhX3x8QYI",
      "title": "Main Office"
    },
    "createdAt": "2024-03-15T10:00:00Z",
    "updatedAt": "2024-03-17T11:45:00Z"
  }
}