Dataset Pixel Visitor Identified

webhookdataset.pixel_visitor_identified

This webhook is triggered when a Faraday Pixel dataset with webhook_notifications on identifies a visitor.

About webhook events

This webhook event is sent as a POST request to your configured webhook endpoints when the specified event occurs in your Faraday account. Configure webhook endpoints using the Create webhook endpoint API.

Event payload

When this event occurs, Faraday will send a POST request to your webhook endpoint with the following JSON payload:

dataobjectrequired
Properties of object
account_idstring<uuid>required

The ID of the account that owns the dataset.

resource_idstring<uuid>required

The ID of the Faraday Pixel dataset.

The name of the Faraday Pixel dataset.

resource_typestringrequired

The type of a resource which is available via the REST SDK.

Example: "scopes"
Allowed values: accounts, atlases, attributes, cohorts, connections, datasets, feature_stores, forecasts, insights, market_opportunity_analyses, migrations, outcomes, persona_sets, places, recommenders, scopes, streams, targets, traits
visitorobjectrequired

The identified visitor. Each key is a column in the Faraday Pixel dataset.

Properties of object
citystring

Standardized when Faraday finds a match, so it can differ from the raw value in the dataset.

emailstring

The visitor's main email address.

email2string

An additional email address for the visitor.

email3string

An additional email address for the visitor.

event_idstringrequired

Matches the event_id of this visitor's row in the dataset.

Standardized when Faraday finds a match, so it can differ from the raw value in the dataset.

last_namestring
page_urlstring
phone1string
phone2string
phone3string
postcodestring

Standardized when Faraday finds a match, so it can differ from the raw value in the dataset.

statestring

Standardized when Faraday finds a match, so it can differ from the raw value in the dataset.

timestampstring<date-time>required

When the visit happened.

user_idstring

The pixel provider's ID for this visitor.

user_ipstring
timestampstring<date-time>required

When Faraday sent the message.

typestringrequired

The type of event that triggered the webhook.

Allowed values: resource.errored, resource.ready_with_update, dataset.pixel_visitor_identified

Example usage

To receive this webhook event, you need to:

  1. Create a webhook endpoint using the Create webhook endpoint API
  2. Ensure your endpoint can receive POST requests with a JSON payload
  3. Verify webhook signatures for security (recommended)
  4. Respond with a 2xx status code to acknowledge receipt of the event