Many parts of Polymart require JavaScript to function correctly.
Click here to enable JavaScript.

Webhooks

Back to Wiki Home
You can edit webhooks on your resource by going to your resource page and clicking the "Webhooks" button in the edit section.

Automatic Discord Integration
Polymart automatically integrates with Discord webhooks. However, this doesn't give you nearly as much customization as if you build your own API for receiving webhooks. If you want to learn more about how to build your own API for receiving webhooks, keep reading!

Webhook Overview
ping — Sent whenever you click the "ping" button on your resource's webhooks page

product.update — Sent whenever you post an update to your resource
product.user.purchase — Sent when a user purchases your resource
product.user.purchaseRemoved — Sent when a user issues a chargeback or is refunded
product.user.firstDownload — Sent when a user first downloads your resource

About Webhooks
When a webhook event is called, Polymart will send a request to the URL you provide on your resource page. With each request, the following headers will be sent:

X-Polymart-Webhook-Version: 1

X-Polymart-Signature will be a signature that verifies that the webhook request is in-fact valid. This is a SHA256 HMAC hash, where the data is the data that was POSTed, and the key is your webhook secret. Your webhook secret generated when you create a new webhook. YOU MUST VALIDATE THAT THIS IS CORRECT. If you do not, attackers will easily be able to send random, invalid webhooks to your server

The data that is POSTed to your webhook will be in this format
{
  "event": <event type>,
  "time": <current unix time>,
  "nonce": <random nonce>,
  "payload": {
    <key 1>: <val 1>,
    <key 2>: <val 2>,
    <...>: <...>
  }
}
So, the top-level information might look something like this
{
  "event": "product.update",
  "time": 1621221768,
  "nonce": "vw4K99IP-VxqeQXm",
  "payload": <...>
}
Putting it all together, this is what a full valid request to https://example.com/polymartWebhook might look like, given the webhook secret JUprnJBTybOej0CC
POST /polymartWebhook HTTP/1.1
X-Polymart-Webhook-Version: 1
X-Polymart-Signature: eed7410849d040452820d048f6b78c49166839ac7279114d0945b7b2d45da36b
Content-Type: application/json
Content-Length: 166

{
    "event": "testEvent",
    "time": 1621221768,
    "nonce": "GQJjh-lcKB-427OL",
    "payload": {
        "webhook": "https://example.com/polymartWebhook"
    }
}
Use this to test your webhook! This webhook event is called when you click the "send a ping" button on your resource's webhooks page.

Format
{
  "event": "ping",
  "time": <current unix time>,
  "nonce": <random nonce>,
  "payload": {
    "product": {
      "id": <resource id>,
      "title": <resource title>,
      "subtitle": <resource subtitle>,
      "url": <resource url>
    },
    "webhook": {
      "url": <your webhook url>
    }
  }
}
Example
{
  "event": "ping",
  "time": 1621221768,
  "nonce": "OFD0LDIMbo8ammqS",
  "payload": {
    "product": {
      "id": "1",
      "title": "CustomItems",
      "subtitle": "Design new Custom items and blocks!",
      "url": "https://polymart.org/resource/1"
    },
    "webhook": {
      "url": "https://example.com/polymartWebhook"
    }
  }
}

If your webhook secret is JUprnJBTybOej0CC, then the signature of this request will be b1a3e4aeee6af9ba4cad28ceb1d54663d53db66bd02a532fe04b9a20a31fb4c3
product.update Back to top
This webhook event is called when your resource is updated.

Format
{
  "event": "resource.update",
  "time": <current unix time>,
  "nonce": <random nonce>,
  "payload": {
    "product": {
      "id": <resource id>,
      "title": <resource title>,
      "subtitle": <resource subtitle>,
      "url": <resource url>
    },
    "previous": {
      "version": <old version>,
      "id": <old version ID>,
      "time": <old version update time>,
      "size": <old size>,
      "fileType": <old file type>,
      "branch": <beta|snapshot|release>
    },
    "update": {
      "version": <new version>,
      "id": <new version ID>,
      "time": <update time>,
      "size": <new size>,
      "fileType": <new file type>,
      "branch": <beta|snapshot|release>,
      "title": <update title>,
      "description": <update description>
    }
  }
}
Example
{
  "event": "product.update",
  "time": 1621221768,
  "nonce": "U7gjIPWvCOpSd4Hu",
  "payload": {
    "product": {
      "id": "1",
      "title": "CustomItems",
      "subtitle": "Design new Custom items and blocks!",
      "url": "https://polymart.org/resource/1"
    },
    "previous": {
      "version": "2.19.5",
      "id": "91",
      "time": 1621218168,
      "size": "716624",
      "fileType": "jar",
      "branch": "snapshot"
    },
    "update": {
      "version": "3.0",
      "id": "107",
      "time": 1621221768,
      "size": "718232",
      "fileType": "jar",
      "branch": "release",
      "title": "Automatic Resource Pack Generation",
      "description": "This version adds an automatic resource pack generator to CustomItems!"
    }
  }
}

If your webhook secret is JUprnJBTybOej0CC, then the signature of this request will be 4d785a3e13e2f1953697ad9306e3edf7d897a14522a35eb7fd5855303c2b4ee3
product.user.purchase Back to top
This webhook event is called when a user purchases your resource

Format
{
  "event": "product.user.purchase",
  "time": <current unix time>,
  "nonce": <random nonce>,
  "payload": {
    "product": {
      "id": <resource id>,
      "title": <resource title>,
      "subtitle": <resource subtitle>,
      "url": <resource url>
    },
    "user": {
      "id": <user id>
    }
  }
}
Example
{
  "event": "product.user.purchase",
  "time": 1621221768,
  "nonce": "LzYVqGKL3322DjW1",
  "payload": {
    "product": {
      "id": "1",
      "title": "CustomItems",
      "subtitle": "Design new Custom items and blocks!",
      "url": "https://polymart.org/resource/1"
    },
    "user": {
      "id": 154249
    }
  }
}

If your webhook secret is JUprnJBTybOej0CC, then the signature of this request will be fa792aeb38b4b1da2a8e296b471163b89d35503d20cd2eba0fca37452dd10204
product.user.purchaseRemoved Back to top
This webhook event is called when you issue a refund to a user, or they issue a chargeback. This event may be called more than once for a given user

Format
{
  "event": "product.user.purchaseRemoved",
  "time": <current unix time>,
  "nonce": <random nonce>,
  "payload": {
    "product": {
      "id": <resource id>,
      "title": <resource title>,
      "subtitle": <resource subtitle>,
      "url": <resource url>
    },
    "user": {
      "id": <user id>
    }
  }
}
Example
{
  "event": "product.user.purchaseRemoved",
  "time": 1621221768,
  "nonce": "hgOrTHGKhEYnJwLP",
  "payload": {
    "product": {
      "id": "1",
      "title": "CustomItems",
      "subtitle": "Design new Custom items and blocks!",
      "url": "https://polymart.org/resource/1"
    },
    "user": {
      "id": 79166
    }
  }
}

If your webhook secret is JUprnJBTybOej0CC, then the signature of this request will be e66527632482a2e628da967de8f2329ae35255caebd12dcbabc8f2f8121f77eb
product.user.firstDownload Back to top
This webhook event is called when a user downloads your resource for the first time

Format
{
  "event": "product.user.firstDownload",
  "time": <current unix time>,
  "nonce": <random nonce>,
  "payload": {
    "product": {
      "id": <resource id>,
      "title": <resource title>,
      "subtitle": <resource subtitle>,
      "url": <resource url>
    },
    "user": {
      "id": <user id>
    }
  }
}
Example
{
  "event": "product.user.firstDownload",
  "time": 1621221768,
  "nonce": "dqvM1yl4NOpPxpbn",
  "payload": {
    "product": {
      "id": "1",
      "title": "CustomItems",
      "subtitle": "Design new Custom items and blocks!",
      "url": "https://polymart.org/resource/1"
    },
    "user": {
      "id": 20935
    }
  }
}

If your webhook secret is JUprnJBTybOej0CC, then the signature of this request will be ca8317fe01b3a6ea0658c9dda5949e528c94ebecf693b4a3341a3bb1dce9bf66