Register a webhook to receive real-time notifications when events occur in your account (e.g., transaction state changes).

Example Request

curl -X POST https://api.neutron.me/api/v2/webhook \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{
    "callback": "https://yourapp.com/webhooks/neutron",
    "secret": "your-webhook-secret-key"
  }'

Request Body

Field	Type	Required	Description
`callback`	string	✅	HTTPS URL that will receive webhook POST requests
`secret`	string	✅	Secret key used to generate the `X-Neutronpay-Signature` header for verification

Example Response

{
  "id": "01e2a3dc-0c34-4e14-92e4-b270c4778d95",
  "callback": "https://yourapp.com/webhooks/neutron",
  "createdAt": 1747889654376
}

Save the id — you'll need it to update or remove the webhook later.

Important Notes

Your callback URL must use HTTPS — webhook payloads contain sensitive transaction data
One webhook per account — creating a new webhook replaces any existing one
Always verify the X-Neutronpay-Signature header using your secret (see Signature Generation)
Your endpoint should return 200 OK promptly — process events asynchronously

Related

Webhook Guide — Complete setup guide with signature verification examples
List Webhooks — Check your current webhook
Update Webhook — Change the callback URL or secret