Setup events
Track Custom Events using Safary's Javascript SDK
Last updated
Track Custom Events using Safary's Javascript SDK
Last updated
Safary makes available after document.readyState === 'complete' a method under window.safary.track, which can be executed while defining an event type, event name and additional parameters — see complete documentation below.
To help the visualization of common events in Safary's dashboards, below we also indicate how to fill the parameters field for some events, such as swap, deposit and withdrawal.
| FIELD | TYPE | USE | DESCRIPTION |
|---|---|---|---|
Example to track two different generic events:
Event of type "click":
Event of type "add-to-favorites"
See the last section of this page for troubleshooting.
To track a swap event, use the track function with "swap" as the eventType, choose any name as eventName, and make sure to add all the required attributes in the field parameters, which are listed below.
Example only with required fields:
Example with the suggested field fromAmountUSD:
Please note that the parameters field can also include any other information you believe is useful to track. For example, in the case of swaps it might be interesting to add properties like the toAmount, toAmountUSD and toCurrency - see the following example with these additional information:
See the last section of this page for troubleshooting.
To track a deposit event, use the track function with "deposit" as the eventType, choose any name as eventName, and make sure to add all the required attributes in the field parameters, which are listed below.
Example only with required fields:
Example with the suggested field amountUSD:
Please note that the parameters field can also include any other information you believe is useful to track. For example, in the case of deposits it might be interesting to add a property like the transactionHash - see the following example with this additional information:
See the last section of this page for troubleshooting.
To track a withdrawal event, use the track function with "withdrawal" as the eventType, choose any name as eventName, and make sure to add all the required attributes in the field parameters, which are listed below.
Example only with required fields:
Example with the suggested field amountUSD:
Please note that the parameters field can also include any other information you believe is useful to track. For example, in the case of withdrawals it might be interesting to add a property like the transactionHash - see the following example with this additional information:
See the last section of this page for troubleshooting.
To track a NFT purchase event, use the track function with "NFT purchase" as the eventType, choose any name as eventName, and make sure to add all the required attributes in the field parameters, which are listed below.
Example only with required fields:
Example with the suggested field amountUSD:
Please note that the parameters field can also include any other information you believe is useful to track. For example, in the case of NFT purchases it might be interesting to add a property like the transactionHash - see the following example with this additional information:
See the last section of this page for troubleshooting.
The form event can be used to track user information. To track a form submission event, use the track function with "form" as the eventType, and any appropriate name as eventName, and make sure to add the required attributes in the field parameters. The parameters field can contain an email or a telegram username, optionally including the user's name.
Example only with required email field:
Example only with required telegram field:
Example with optional name field included:
Please note that the parameters field can also include any other information you believe is useful to track. For form submissions, additional properties relevant to your application's needs might be included.
See the last section of this page for troubleshooting.
The social_login event can be used to track information regarding logins made using socials. To track a social login event, use the track function with "social_login" as the eventType, and any appropriate name as eventName, and make sure to add the required attributes in the field parameters.
The parameters field should contain at least one of the three possible fields: twitter_username, lens_handle and farcaster_id described below. (note these field names are case sensitive).
Example only with required twitter_username field:
Example only with required lens_handle field:
Example only with required farcaster_id field:
Please note that the parameters field can also include any other information you believe is useful to track. For form submissions, additional properties relevant to your application's needs might be included.
See the last section of this page for troubleshooting.
Step 1: Declaring safary in the window object.
Step 2: In your code, when some action you want to track is triggered, containing, for example, some contextualData, you can use safary.track as follows.
To track any custom event, for example, a "click" event:
To track a "swap event following our standards define above, including the optional field (fromAmountUSD) and an additional information (chainId):
Required arguments:
Note that eventType + eventName are required arguments for safary.track .
Therefore, for example, the following would not work:
Required format:
Note that the parameters used in the both tracking functions is required to be an object.
Therefore, for example, passing a string as parameters would not work:
| parameters | TYPE | USE | DESCRIPTION |
|---|---|---|---|
| parameters | TYPE | USE | DESCRIPTION |
|---|---|---|---|
| parameters | TYPE | USE | DESCRIPTION |
|---|---|---|---|
| parameters | TYPE | USE | DESCRIPTION |
|---|---|---|---|
| parameters | TYPE | USE | DESCRIPTION |
|---|---|---|---|
| parameters | TYPE | USE | DESCRIPTION |
|---|---|---|---|
eventType
string
Required
Type/Category of the event. For example: “click”, “stake”, “swap”.
eventName
string
Required
Specific name of the event of the type defined. For example: “submit button”, “swap offer 1”, “buy in main page”.
parameters
object
Optional
A dictionary of properties for the specific event being tracked. For example, if the event was “purchase”, it might have properties like “price” and “product”.
walletAddress
string
Required
The wallet address being used for the swap.
fromAmount
number
Required
The amount being from which the swap is occurring.
fromCurrency
string
Required
The currency from which the swap is occurring.
fromAmountUSD
number
Optional
The currency from which the swap is occurring in USD. Fill if the USD amount is available during the function call.
contractAddress
string
Required
The contract address related to the swap. This will be used in the future to check if the swap was actually successful using on-chain data.
walletAddress
string
Required
The wallet address being used for the deposit.
amount
number
Required
The amount being deposited.
currency
string
Required
The currency of the amount being deposited.
amountUSD
number
Optional
The amount being deposited in USD. Fill if the USD amount is available during the function call.
contractAddress
string
Required
The contract address related to the deposit. This will be used in the future to check if it was actually successful using on-chain data.
walletAddress
string
Required
The wallet address used for the withdrawal.
amount
number
Required
The amount being withdrawn.
currency
string
Required
The currency of the amount being withdrawn.
amountUSD
number
Optional
The amount being withdrawn in USD. Fill if the USD amount is available during the function call.
contractAddress
string
Required
The contract address related to the withdrawal. This will be used in the future to check if it was actually successful using on-chain data.
walletAddress
string
Required
The wallet address used for the purchase.
amount
number
Required
The amount of the NFT purchase.
currency
string
Required
The currency of the amount of the NFT purchase.
amountUSD
number
Optional
The amount of the NFT purchase in USD. Fill if the USD amount is available during the function call.
contractAddress
string
Required
The contract address related to the NFT purchase. This will be used in the future to check if it was actually successful using on-chain data.
tokenId
number
Required
The token id of the NFT referenced in the contract address.
string
Required *
*optional when telegram is set
telegram
string
Required *
Telegram username *optional when email is set
name
string
Optional
twitter_username
string
Required *
*Optional when lens_handle or farcaster_id is set
Twitter/X username. For example, for https://x.com/safaryclub, send only "safaryclub".
lens_handle
string
Required *
*Optional when twitter_username or farcaster_id is set
Lens handle without the namespace. For example, for https://hey.xyz/u/ricardocarvalho send only "ricardocarvalho"
farcaster_id
number
Required *
*Optional when twitter_username or farcaster_id is set
Farcaster ID (aka FID). For example, for https://warpcast.com/jhv click on the three dots and then click on "About" to see the FID of 1385.