Email Activity Updated

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.email_marketing.v1.campaign.

slugstring

Event name. Expected email_activity_updated.

entityIdstring

ID of the entity associated with the event.

eventTimestringformat date-time

Event timestamp.

triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring

If present, indicates the action that triggered the event.

actionEventobject

Event information.


Was this helpful?
Yes
No