Webhook Events: Collections

The collection webhook event signals when a collection is created or modified. The collection's metadata is present in the payload of these events.

Sections

• What information does the collection webhook event provide?

---

What information does the collection webhook event provide?

The collection_updated event is triggered when a new collection is deployed on zkEVM or when an existing collection undergoes updates, such as modifications to its metadata. The metadata of the collection is included in the payload of each collection_updated event. The collection_updated event can be valuable for marketplaces, as it allows them to stay informed about new collections created by game studios.The collection_updated event can valuable for marketplaces, as it allows them to stay informed about new collections created by game studios.

This event does not indicate when a collection mints a new asset. For information regarding the minting of new assets within a collection, you should refer to the webhooks NFT or Activities events, as they provide details on such activities.

Example responses

Below are some examples of collection_updated events for common use-cases:

New collection deployed

{
  "event_name": "imtbl_zkevm_collection_updated",
  "event_id": "018b3c2e-d9a1-1fcf-0628-cd89b4f82c56",
  "chain": "imtbl-zkevm-testnet",
  "data": {
    "chain": {
      "id": "eip155:13473",
      "name": "imtbl-zkevm-testnet"
    },
    "contract_address": "0xa02456c5a672d83ef782716611793ce387ce7421",
    "indexed_at": "2023-10-17T05:49:45.231508Z",
    "updated_at": "2023-10-17T05:49:45.231508Z",
    "contract_type": "erc721",
    "symbol": null,
    "name": null,
    "image": null,
    "contract_uri": null,
    "description": null,
    "external_link": null,
    "metadata_synced_at": null,
    "decimals": null,
    "root_contract_address": null
  }
}

Existing collection updated

{
  "event_name": "imtbl_zkevm_collection_updated",
  "event_id": "018b3c2e-daae-4f17-36b5-bd5cf45c4a7c",
  "chain": "imtbl-zkevm-testnet",
  "data": {
    "chain": {
      "id": "eip155:13473",
      "name": "imtbl-zkevm-testnet"
    },
    "contract_address": "0xa02456c5a672d83ef782716611793ce387ce7421",
    "indexed_at": "2023-10-17T05:49:45.231508Z",
    "updated_at": "2023-10-17T05:49:45.513751Z",
    "contract_type": "erc721",
    "symbol": "MY_OWN_COLL",
    "name": "My custom ERC721 contract name",
    "image": null,
    "contract_uri": "https://www.example.com/contract.json",
    "description": null,
    "external_link": null,
    "metadata_synced_at": null,
    "decimals": null,
    "root_contract_address": null
  }
}