Skip to content

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

Name Type Description Notes
messageId String Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
webhookId UUID ID of webhook entity being triggered
webhookName String Name of the webhook being triggered [optional]
eventName EventNameEnum Name of the event type webhook is being triggered for.
contactId UUID Contact ID
groupId UUID Contact group ID [optional]
firstName String Contact first name [optional]
lastName String Contact last name [optional]
company String Contact company name [optional]
primaryEmailAddress String Primary email address for contact [optional]
emailAddresses List Email addresses for contact
tags List Tags for contact
metaData Object [optional]
optOut Boolean Has contact opted out of emails
createdAt OffsetDateTime Date time of event creation

Enum: EventNameEnum

Name Value
EMAIL_RECEIVED "EMAIL_RECEIVED"
NEW_EMAIL "NEW_EMAIL"
NEW_CONTACT "NEW_CONTACT"
NEW_ATTACHMENT "NEW_ATTACHMENT"
EMAIL_OPENED "EMAIL_OPENED"
EMAIL_READ "EMAIL_READ"
DELIVERY_STATUS "DELIVERY_STATUS"
BOUNCE "BOUNCE"
BOUNCE_RECIPIENT "BOUNCE_RECIPIENT"
NEW_SMS "NEW_SMS"