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

memberof WebhookNewContactPayload


contactId

contactId: string

memberof WebhookNewContactPayload


createdAt

createdAt: Date

memberof WebhookNewContactPayload


emailAddresses

emailAddresses: string[]

memberof WebhookNewContactPayload


eventName

Optional eventName: WebhookNewContactPayloadEventNameEnum

Name of the event type webhook is being triggered for.

memberof WebhookNewContactPayload


firstName

Optional firstName: string

memberof WebhookNewContactPayload


groupId

Optional groupId: string

memberof WebhookNewContactPayload


lastName

Optional lastName: string

memberof WebhookNewContactPayload


messageId

Optional 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

Optional optOut: boolean

memberof WebhookNewContactPayload


primaryEmailAddress

Optional primaryEmailAddress: string

memberof WebhookNewContactPayload


tags

tags: string[]

memberof WebhookNewContactPayload


webhookId

Optional webhookId: string

ID of webhook entity being triggered

memberof WebhookNewContactPayload


webhookName

Optional webhookName: string

Name of the webhook being triggered

memberof WebhookNewContactPayload