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": 1664391453,
  "nonce": "G1qcvbHcOq8jovN6",
  "payload": <...>
}

Putting it all together, this is what a full valid request to https://example.com/polymartWebhook might look like, given the webhook secret ZriyAKUtWqFX9Zdv

POST /polymartWebhook HTTP/1.1
X-Polymart-Webhook-Version: 1
X-Polymart-Signature: 2f6e0033e4d31733e2136bb2246377a50a624c32df65ee339e74d246106cd352
Content-Type: application/json
Content-Length: 166

{
    "event": "testEvent",
    "time": 1664391453,
    "nonce": "k-DDScUHab9uHpsa",
    "payload": {
        "webhook": "https://example.com/polymartWebhook"
    }
}

ping Back to top

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": 1664391453,
  "nonce": "2JbLIOqJ4HLGKu4V",
  "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 ZriyAKUtWqFX9Zdv, then the signature of this request will be 85ad2973b38f2423958ec7e0272f08b64d849443d4e3f842a3f18b0c1bf63968

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": 1664391453,
  "nonce": "T-vUjtRHvxYjorLc",
  "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": 1664387853,
      "size": "716624",
      "fileType": "jar",
      "branch": "snapshot"
    },
    "update": {
      "version": "3.0",
      "id": "107",
      "time": 1664391453,
      "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 ZriyAKUtWqFX9Zdv, then the signature of this request will be 9adbc39b6b78646b2e6fe277241086df0af9649f9e8e0171f9a42cedebac2e8d

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": 1664391453,
  "nonce": "MavVh-aGTCZi1Nwz",
  "payload": {
    "product": {
      "id": "1",
      "title": "CustomItems",
      "subtitle": "Design new Custom items and blocks!",
      "url": "https://polymart.org/resource/1"
    },
    "user": {
      "id": 85141
    }
  }
}

If your webhook secret is ZriyAKUtWqFX9Zdv, then the signature of this request will be d8429c8ffd0ead173cb743f270fd847e80a9f3cdffaf79c81b2074ff36169752

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": 1664391453,
  "nonce": "xGXBpgNgh9dsuXmV",
  "payload": {
    "product": {
      "id": "1",
      "title": "CustomItems",
      "subtitle": "Design new Custom items and blocks!",
      "url": "https://polymart.org/resource/1"
    },
    "user": {
      "id": 54825
    }
  }
}

If your webhook secret is ZriyAKUtWqFX9Zdv, then the signature of this request will be 9764f8499e7f1aa34852c76d0033e567ed06669099c2bafc27d0259da3faf192

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": 1664391453,
  "nonce": "wcgJE_lSt8oKC456",
  "payload": {
    "product": {
      "id": "1",
      "title": "CustomItems",
      "subtitle": "Design new Custom items and blocks!",
      "url": "https://polymart.org/resource/1"
    },
    "user": {
      "id": 40705
    }
  }
}

If your webhook secret is ZriyAKUtWqFX9Zdv, then the signature of this request will be 2fbda1fa54415d23ae83dad4c8991578e138083a75679bc48e32246695f302f4