Webhooks

In this guide, we will look at how to register and consume webhooks to integrate your app with Underdog.

With Webhooks, your app can know when something happens in Underdog, such as creating a Project or minting an NFT.

Registering Webhooks

To register a new Webhook, you need to have a URL in your app that Underdog can call. You can configure a new Webhook from the Underdog dashboard. Add your URL and pick the events you want to listen for.

Now, whenever something of interest happens in Underdog, a Webhook is fired off by Underdog. In the next section, we'll look at how to consume Webhooks.

Consuming Webhooks

When your app receives a webhook request from Underdog, check the type attribute to see what event caused it. The first part of the event type will tell you the payload type, e.g., an NFT, Project, etc.

Example Webhook payload

{
  "id": "66396cba-f6f7-488e-8431-665598548661",
  "type": "collection.create",
  "data": {
    "mintAddress": "GQw5KBtUo1tUa29BsFEJ4F9mdFsXALoHRTRaBfAvFsbU"
    // ...
  }
}

In the example above, there was a project.create.

Transaction Types

Transaction Type	Details
project.create	Project was successfully created
project.nft.create	NFT in a Project was successfully created
project.nft.update	NFT in a Project was successfully updated
project.nft.revoke	NFT in a Project was successfully revoked
project.nft.burn	NFT in a Project was successfully burned

Example payload

{
  "id": "12b9d241-bff6-4e64-91d7-3b19d27b42f6",
  "type": "project.create",
  "data": {
    "mintAddress":"DoBjCkCgwpqUQEKqEnjEsi8vStUch6xbHAoERSNK5WQM",
    "superAdminAddress":"Aht2mY2BKAkt7aJtTkeMEyrZH7rG2UNFt3sVaKTQtxmX",
    "orgId": 1,
    "projectId": 1,
    "transferable": true,
    "nftId": 1,
    "name":"Project #1",
    "description":"Description for Project #1",
    "image":"https://exmaple.com/project.png",
  }
}

API Reference

Webhooks