Appearance
Interface: IHoneypot
Table of contents
Methods
Methods
flow
▸ flow(flowId, instanceId?): Promise<IFlow>
Parameters
| Name | Type |
|---|---|
flowId | string |
instanceId? | null | string |
Returns
Promise<IFlow>
geofence
▸ geofence(): void
Returns
void
get
▸ get(): Promise<any>
Returns
Promise<any>
identify
▸ identify(id, props?, type?): Promise<void>
This method provides a way to link additional user information to a handprint. It is not required but is highly recommended since it allows you to link handprints back to your system.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The account ID, email address, or wallet address (depending on which type you select) |
props? | null | Record<string, any> | An optional object containing additional metadata. e.g. {"org": "acme"} |
type? | null | "account" | "email" | "merchant_id" | "partner_id" | "web3_wallet" | "geofence_ref" | The type of identity you are linking Default Value account |
Returns
Promise<void>
Remarks
Please do not provide PII in the props argument. The only PII we accept is linking an email address explicitly using the 'email' identity type (see the examples below for more details).
Example
ts
// link an account with no additional metadata (null second argument)
honeypot.identify('123', null, 'account')
// link an account with some additional metadata
honeypot.identify('123', {'internal': true}, 'account')
// link an email
honeypot.identify('user@example.com', null, 'email')
// link a web3 wallet address
honeypot.identify('0x000...', {'chain': 'BTC'}, 'web3_wallet')
// link a merchant ID
honeypot.identify('merchant-123', {}, 'merchant_id')
// link a partner ID
honeypot.identify('partner-123', {}, 'partner_id')setup
▸ setup(config): any
Parameters
| Name | Type |
|---|---|
config | HoneypotConfig |
Returns
any
track
▸ track(eventType, eventProperties?): Promise<any>
Parameters
| Name | Type |
|---|---|
eventType | string |
eventProperties? | null | Record<string, any> |
Returns
Promise<any>