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

Hierarchy

  • WebhookNewContactPayload

Properties

company?: string

Contact company name

Memberof

WebhookNewContactPayload

contactId: string

Contact ID

Memberof

WebhookNewContactPayload

createdAt: Date

Date time of event creation

Memberof

WebhookNewContactPayload

emailAddresses: string[]

Email addresses for contact

Memberof

WebhookNewContactPayload

Name of the event type webhook is being triggered for.

Memberof

WebhookNewContactPayload

firstName?: string

Contact first name

Memberof

WebhookNewContactPayload

groupId?: string

Contact group ID

Memberof

WebhookNewContactPayload

lastName?: string

Contact last name

Memberof

WebhookNewContactPayload

messageId: string

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

Memberof

WebhookNewContactPayload

metaData?: object

Memberof

WebhookNewContactPayload

optOut: boolean

Has contact opted out of emails

Memberof

WebhookNewContactPayload

primaryEmailAddress?: string

Primary email address for contact

Memberof

WebhookNewContactPayload

tags: string[]

Tags for contact

Memberof

WebhookNewContactPayload

webhookId: string

ID of webhook entity being triggered

Memberof

WebhookNewContactPayload

webhookName?: string

Name of the webhook being triggered

Memberof

WebhookNewContactPayload