Webhook Request Format Update

Overview

Webhook request format has been upgraded from application/x-www-form-urlencoded to application/json.

Change Details

Previous Format (Legacy)

Content-Type

application/x-www-form-urlencoded

Request Example

Notes

All data is sent via the data field

The data field is a JSON string and requires additional parsing

New Format (Current)

Content-Type

application/json

Request Example

Notes

The request body is a standard JSON object

No additional parsing is required

Easier to read and integrate

Key Differences

Item	Legacy (Form)	Current (JSON)
Content-Type	application/x-www-form-urlencoded	application/json
Data Structure	`data=JSON string`	Standard JSON
Parsing	Requires JSON.parse	Direct parsing
Readability	Low	High
Recommended	❌ No	✅ Yes

Migration Guide

For Existing Integrations

Update your webhook endpoint to accept application/json

Remove logic that parses data as a JSON string

Directly read fields from the request body

Example (Node.js)

Legacy

Current

Compatibility Notes

Legacy format (application/x-www-form-urlencoded) may still be supported for existing merchants

New integrations should use application/json

Important Notes

Ensure your server supports JSON request parsing

Always return HTTP 200 as soon as the event is received

Webhook events may be retried if not acknowledged

Recommended Practice

Use application/json for all new webhook integrations to ensure better compatibility and maintainability.

Webhook Request Format Update

Webhook Request Format Update#

Overview#

Change Details#

Previous Format (Legacy)#

New Format (Current)#

Key Differences#

Migration Guide#

For Existing Integrations#

Example (Node.js)#

Compatibility Notes#

Important Notes#

Recommended Practice#

Webhook Request Format Update

Overview

Change Details

Previous Format (Legacy)

New Format (Current)

Key Differences

Migration Guide

For Existing Integrations

Example (Node.js)

Compatibility Notes

Important Notes

Recommended Practice