Webhook

Export pixel data to your own 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 X minutes. TODO PUT A REAL TIME VALUE HERE

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.

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.
Screen recording showing how to set up a webhook

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:

HeaderValueType
loadIdA unique identifier for each pixel loadstring (UUID)
idUnique identifier for the pixelstring
typestring
timestampThe timestamp of the load, expressed in UTCtimestamp
recipientIdstring
metadataJSON object
prefetchedboolean
readMillisecondsThe time the reader spent reading the email, in milliseconds (when available)integer
ipAddressThe IP address of the user who opened the email (when available)cidr
countryThe country of the user who opened the email (when available)string (2 char)
userAgentThe user agent of the user who opened the email (when available)string
emailClientThe email client used to open the email (when available)string
renderingEngineThe rendering engine used to open the email (when available)string
referrerThe referrer of the user who opened the email (when available)string
proxiedWhether the user was proxied (when available)boolean
webhookStatusThe status of the webhookstring
workspaceIdThe ID of the workspace that the pixel load belongs tostring (UUID)
createdAtThe timestamp of when the pixel was created, expressed in UTCtimestamp
updatedAtThe timestamp of when the pixel was last updated, expressed in UTCtimestamp
nameThe name of the pixelstring