Fingerprint

Dummy path to describe webhook format.

Fake path to describe webhook format. More information about webhooks can be found in the documentation

trace/webhook

Request

  • Base URL: https://api.fpjs.io
  • URL: https://api.fpjs.io/webhook
  • Auth: one of:
    • API key in header Auth-API-Key
    • API key in query parameter api_key

Request body

requestIdstring required

Unique identifier of the user's request.

urlstring required

Page URL from which the request was sent.

ipstring required

IP address of the requesting browser or bot.

environmentIdstring

Environment ID of the event.

tagTag

A customer-provided value or an object that was sent with identification request.

timestring date-time required

Time expressed according to ISO 8601 in UTC format, when the request from the JS agent was made. We recommend to treat requests that are older than 2 minutes as malicious. Otherwise, request replay attacks are possible.

timestampinteger required

Timestamp of the event with millisecond precision in Unix time.

linkedIdstring

A customer-provided id that was sent with the request.

visitorIdstring

String of 20 characters that uniquely identifies the visitor's browser or mobile device.

visitorFoundboolean

Attribute represents if a visitor had been identified before.

incognitoboolean

Flag if user used incognito session.

clientReferrerstring
componentsRawDeviceAttributes

It includes 35+ raw browser identification attributes to provide Fingerprint users with even more information than our standard visitor ID provides. This enables Fingerprint users to not have to run our open-source product in conjunction with Fingerprint Pro Plus and Enterprise to get those additional attributes. Warning: The raw signals data can change at any moment as we improve the product. We cannot guarantee the internal shape of raw device attributes to be stable, so typical semantic versioning rules do not apply here. Use this data with caution without assuming a specific structure beyond the generic type provided here.

userAgentstring
rawDeviceAttributesWebhookRawDeviceAttributes

It includes 35+ raw browser identification attributes to provide Fingerprint users with even more information than our standard visitor ID provides. This enables Fingerprint users to not have to run our open-source product in conjunction with Fingerprint Pro Plus and Enterprise to get those additional attributes. Warning: The raw signals data can change at any moment as we improve the product. We cannot guarantee the internal shape of raw device attributes to be stable, so typical semantic versioning rules do not apply here. Use this data with caution without assuming a specific structure beyond the generic type provided here.

replayedboolean

true if we determined that this payload was replayed, false otherwise.

Response

Dummy for the schema

Changes

No recorded changes to this operation across all 1 revision of this API.