Webhook

You can auto export all pixel load data to your own webhook, so you can store/process the data yourself. The data is sent in the body of a POST request to the webhook once every 5 minutes.

Setup

Navigate to the workspace's settings page by clicking on the workspace name in the upper left corner and then clicking on the Workspace Settings button. Scroll down to the "Analytics Webhook" section. Enter the full URL of your webhook in the Webhook URL field. Click the Save button. Be sure to entire an absolute URL, as data will only be sent to absolute URLs. The URL must include a protocol (ex: https://). Return to this page at any time to change or remove the webhook. You can only have one webhook.

Silent video of the Parcel window. The cursor moves to the Workspace name in the upper left, and clicks on it, revealing a menu that contains the names of the other workspaces, as well as "Edit workspace" and "Create workspace" options. "Edit workspace" is clicked and the page navigates to the workspace settings page, which contains several sections. The user scrolls down to the "Analytics Webhook" section, which has an editable text field and a save button. The user types a URL into the text field, and then clicks the Save button. A notification appears in the bottom right corner of the screen confirming that the url was saved.

Usage

Once configured, pixel load data will be sent to the webhook at regular intervals. Only pixel loads that have not yet been sent will be sent. If ever there are more than 1000 pixel loads to send, the data will be sent in batches of up to 1000 rows. The data will be sent as an array of JSON objects with the following properties:

Element	Description	Type
loadId	A unique identifier for each pixel load	string (UUID)
id	Unique identifier for the pixel	string
type	The type of the load 'PRINT', 'FORWARD', 'DARK', 'LIGHT', 'CUSTOM', 'GENERIC'	string
timestamp	The timestamp of the load, expressed in UTC	timestamp
recipientId	An ID you can set to later correlate with each user in your own system	string
metadata	Any extra data you'd like to include for your own system/use	JSON object
prefetched	Whether the load was prefetched by a automated system or some privacy measure (ex: Apple privacy protection)	boolean
readMilliseconds	The time the reader spent reading the email, in milliseconds (when available)	integer
ipAddress	The IP address of the user who opened the email (when available)	cidr
country	The country of the user who opened the email (when available)	string (2 char)
userAgent	The user agent of the user who opened the email (when available)	string
emailClient	The email client used to open the email (when available)	string
renderingEngine	The rendering engine used to open the email (when available)	string
referrer	The referrer of the user who opened the email (when available)	string
proxied	Whether the email was loaded through a proxy server to protect the recipient privacy info (ex: Gmail and Yahoo) (when available)	boolean
webhookStatus	The status of the webhook	string
workspaceId	The ID of the workspace that the pixel load belongs to	string (UUID)
createdAt	The timestamp of when the pixel was created, expressed in UTC	timestamp
updatedAt	The timestamp of when the pixel was last updated, expressed in UTC	timestamp
name	The name of the pixel	string