Skip to content

Interface: 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.

export

interface WebhookNewContactPayload

Table of contents

Properties

Properties

company

Optional company: string

Contact company name

memberof WebhookNewContactPayload


contactId

contactId: string

Contact ID

memberof WebhookNewContactPayload


createdAt

createdAt: Date

Date time of event creation

memberof WebhookNewContactPayload


emailAddresses

emailAddresses: string[]

Email addresses for contact

memberof WebhookNewContactPayload


eventName

eventName: WebhookNewContactPayloadEventNameEnum

Name of the event type webhook is being triggered for.

memberof WebhookNewContactPayload


firstName

Optional firstName: string

Contact first name

memberof WebhookNewContactPayload


groupId

Optional groupId: string

Contact group ID

memberof WebhookNewContactPayload


lastName

Optional lastName: string

Contact last name

memberof WebhookNewContactPayload


messageId

messageId: string

Idempotent message ID. Store this ID locally or in a database to prevent message duplication.

memberof WebhookNewContactPayload


metaData

Optional metaData: object

memberof WebhookNewContactPayload


optOut

optOut: boolean

Has contact opted out of emails

memberof WebhookNewContactPayload


primaryEmailAddress

Optional primaryEmailAddress: string

Primary email address for contact

memberof WebhookNewContactPayload


tags

tags: string[]

Tags for contact

memberof WebhookNewContactPayload


webhookId

webhookId: string

ID of webhook entity being triggered

memberof WebhookNewContactPayload


webhookName

Optional webhookName: string

Name of the webhook being triggered

memberof WebhookNewContactPayload