WebhookNewContactPayload

NEW_CONTACT webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is received by the inbox that your webhook is attached to that contains a recipient that has not been saved as a contact.

Properties

NameTypeDescriptionNotes
companyString[optional]
contactIdUUID
createdAtOffsetDateTime
emailAddressesList
eventNameEventNameEnumName of the event type webhook is being triggered for.[optional]
firstNameString[optional]
groupIdUUID[optional]
lastNameString[optional]
messageIdStringIdempotent message ID. Store this ID locally or in a database to prevent message duplication.[optional]
metaDataObject[optional]
optOutBoolean[optional]
primaryEmailAddressString[optional]
tagsList
webhookIdUUIDID of webhook entity being triggered[optional]
webhookNameStringName of the webhook being triggered[optional]

Enum: EventNameEnum

NameValue
EMAIL_RECEIVED“EMAIL_RECEIVED”
NEW_EMAIL“NEW_EMAIL”
NEW_CONTACT“NEW_CONTACT”
NEW_ATTACHMENT“NEW_ATTACHMENT”
EMAIL_OPENED“EMAIL_OPENED”