Skip to main content
POST
Scope: nft:orders Registers this key’s webhook (201, with the signing secret, shown once), or changes its URL (200, "secret": null: the secret stays the same). Events, signatures and retries: Webhooks.
  • One webhook per key. To get a new secret, delete the webhook and register again.
  • A key that has been rotated can’t register or re-enable a webhook (409 KEY_ROTATED). A rotation moves the webhook to the new key by itself.
string
required
A public https:// URL on port 443, with a hostname (not an IP address) and no login in it, up to 2048 characters. The sandbox has the same rule: to receive on your own machine, use a tunnel such as ngrok.

Response

object
id, url, enabled, created_at and updated_at. Use id with Test a webhook and Delete a webhook.
string | null
The signing secret, whsec_..., on the first registration only. Store it: it is never returned again. null when you changed the URL of an existing webhook.

Errors