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": 1733446994,
  "nonce": "ynwniSuRZUjYTfuc",
  "payload": <...>
}

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

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

{
    "event": "testEvent",
    "time": 1733446994,
    "nonce": "yyTlxtQ7BOozitbA",
    "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": 1733446994,
  "nonce": "FW7NIk0ojlv4VCwJ",
  "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 OEEvFv6N0w-zXaBk, then the signature of this request will be 8ee73aa1ae954074d03517e7a4190940ade80ce11a50fb256b42ba5670c8f70f

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": 1733446994,
  "nonce": "ZLUtkHgXuFiu6RwM",
  "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": 1733443394,
      "size": "716624",
      "fileType": "jar",
      "branch": "snapshot"
    },
    "update": {
      "version": "3.0",
      "id": "107",
      "time": 1733446994,
      "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 OEEvFv6N0w-zXaBk, then the signature of this request will be c5e68afe990f5b5d910cc8122ba8e31fa78bfef96286c1dd9260a20925b8f327

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

If your webhook secret is OEEvFv6N0w-zXaBk, then the signature of this request will be d128325c2c5f4057b030763982785dad341902200052bd001b1179ad9797a1d8

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

If your webhook secret is OEEvFv6N0w-zXaBk, then the signature of this request will be 5c90ddb6edc2926c02bc0ac0e58085f2974fcdca6c7916697ba19318fb587c70

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

If your webhook secret is OEEvFv6N0w-zXaBk, then the signature of this request will be 8d30c6fc97829db8479ff7c6fbf15b18b90ec5c78d02ccd1db6f75d95112c01f