Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

Information about the updated campaign email activity.

event

CampaignEmailActivityUpdated

Triggered each time an email campaign has a new recipient activity.

New recipient activity includes when each email in a campaign is `DELIVERED`, `OPENED`,
or `BOUNCED`. Also, when a URL inside the email is `CLICKED`.

The type of activity that triggered the webhook is in `actionEvent.body` and can be one of:
+ `delivery`: Email was delivered to recipient.
+ `click`: Recipient clicked on a URL in an email.
+ `open`: Recipient opened an email.
+ `softBounce`: Email soft bounced when sent to a recipient.
+ `hardBounce`: Email hard bounced when sent to a recipient.


  export function wixEmailMarketing_onCampaignEmailActivityUpdated(event) {
    const eventId = event.metadata.id
    const entityId = event.data.campaign._id;
  }

  

onCampaignEmailActivityUpdated example

onCampaignEmailActivityUpdated

void

---
title: Introduction
---

# Introduction

Wix Email Marketing events are triggered when certain events occur with email marketing in your site's backend. You can write event handlers that react to these events. Event handler functions receive data that correspond to the backend event that has occurred. Use event handlers to create custom responses to email marketing events.

>**Note:** Backend events aren't triggered when previewing your site. 

## Working with Email Marketing Event Handlers

To add an email marketing event handler, add an **events.js** file to the **Backend** section of your site if one does not already exist. All event handler functions for your site are defined in this file.

Event handler functions are defined using the following pattern:

```js
export function <wixAppName>_<eventName>(event) { }
```

For example, an event handler that handles the creation of a site member looks like this:

```js
export function wixEmailMarketing_onCampaignEmailActivityUpdated(event) { }
```



velo-events_wix-email-marketing.v2

ActivityType

BackendEventMetadata

ID of the entity associated with the event.

entityId

string

eventTime

Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users.

triggeredByAnonymizeRequest

boolean

Campaign

campaignId

dateCreated

dateUpdated

distributionStatus

Enum

Editor type. Either web app, or mobile app.

editorType

CampaignEditorTypeEnum

Email subject of the campaign (initially copied from the template).
TODO: Deprecated (moved to "GetComposerResponse").

emailSubject

firstImageUrl

Publishing data (present only if campaign is published).

publishingData

PublishingData

snapshotImageUrl

status

CampaignStatusEnum

Marketing campaign title. For sent campaigns this will match the email subject if subject was not explicitly provided on sending.
For published campaigns - the title will be the first line of text.

title

visibilityStatus

CampaignVisibilityStatusEnum

CampaignCreated

entity

metadata

CampaignDeleted

CampaignDistributedEvent

CampaignDistributedEventEvent

data

EmailActivityUpdated

CampaignPausedEvent

CampaignPausedEventEvent

CampaignPublishedEvent

landingPageUrl

Estimation of recipient list size (optional).

mailingListSizeEstimate

number

CampaignPublishedEventEvent

CampaignRejectedEvent

CampaignRejectedEventEvent

CampaignScheduledEvent

sendAt

CampaignScheduledEventEvent

CampaignSendingStateEnum

CampaignStatistics

Marketing campaign's email distribution statistics.

emailCampaign

DistributionStatistics

Marketing campaign's landing page statistics.

landingPage

LandingPageStatistics

Combined landing page and email distribution statistics.

total

TotalStatistics

CampaignTerminatedEvent

CampaignTerminatedEventEvent

CampaignTypeEnum

Click

userAgent

bounced

Number of recipients who clicked a link in the email.

If a single recipient clicks a link in an email twice, it is counted as one unique click.
If a single recipient clicks different links in an email, it is counted as one unique click.

clicked

Number of recipients who reported email as spam.

complained

delivered

Number of emails not sent because the campaign was terminated.

notSent

Number of recipients who opened an email.

If a single recipient opens an email twice, it is counted as one unique open.

opened

click

Email hard bounced when sent to a recipient.

Indicates a permanent error sending your email. For example, the email address does not exist.

hardBounce

open

Email soft bounced when sent to a recipient.

Indicates a temporary issue sending your email. For example, the email server receiving the email is under a heavy load.
For soft bounces, you should wait and try again at a later time.

softBounce

activityType

[Contact ID](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object) of recipient.

onCampaignEmailActivityUpdated( )