Entrance

Overview

The NFT Kit Entrance Event webhook allows your application to receive real-time notifications whenever an NFT entrance event occurs within EQHub's NFT Kit. Each time an NFT is used to grant access or validate entry, EQHub will send detailed transaction data to your configured webhook endpoint.

Webhook Payload Structure Example

{
  "app": "EQHub",
  "data": {
    "transaction_hash": "0xExampleTransactionHash",
    "token_id": "1",
    "entrance_hash": "0xExampleEnteranceHash",
    "authorizer_address": "0xAuthorizerAddress",
    "timestamp": "2025-02-17T09:45:15.000Z"
  },
  "event_name": "NFT_KIT_ENTRANCE",
  "service_identifier": "NFT_KIT",
  "resource_identifier": 1
}

Payload Field Descriptions

Field	Type	Description
`app`	String	Fixed value: "EQHub"
`data.transaction_hash`	String	Blockchain hash representing the entrance transaction
`data.token_id`	String	Identifier of the NFT used for entrance
`data.entrance_hash`	String	Unique hash identifying the specific entrance event
`data.authorizer_address`	String	Blockchain address of the entity authorizing entrance
`data.timestamp`	String	ISO timestamp when entrance occurred
`event_name`	String	Fixed value: "NFT_KIT_ENTRANCE"
`service_identifier`	String	Fixed value: "NFT_KIT"
`resource_identifier`	Integer	Identifier for NFT Kit (`kit_id`)

How to Receive NFT Kit Entrance Events

To enable webhook notifications:

Set the parameter useWebhook to true when making NFT Kit API requests.
Include a valid webhookUrl. If useWebhook is set to true without specifying a URL, notifications will default to the initially configured webhook URL.

Example:

{
  "useWebhook": true,
  "webhookUrl": "https://your-callback-url.com/webhook"
}