Payload
A payload is the meaningful data carried within a request, response, webhook, or other message exchanged between systems.
It is the information the message is actually intended to deliver.
What It Means in Practice
A webhook notifying a system about a new order might send a payload such as:
{
"order_id": 1842,
"status": "paid",
"total": 149.99
}The surrounding request includes information about how the message was delivered.
The payload contains the useful business information.
Where Payloads Appear
Payloads can appear in:
- API Requests
- API Responses
- Webhooks
- Event systems
- Message queues
- Data synchronization
- Integrations
JSON is one common payload format.
Payload vs. Event
An event describes what happened.
The payload contains information about what happened.
For example:
Event order.created
Payload
- Order ID
- Customer
- Products
- Total
- Timestamp
The same distinction appears in Analytics Events and webhooks.
Why It Matters
Payload design affects how tightly systems depend on one another.
If an integration expects twenty undocumented fields from another service, even a small upstream change may break it.
Smaller, clearly defined payloads are often easier to maintain.
Common Problems
Common problems include:
- Sending unnecessary sensitive information
- Large payloads
- Fields changing without Versioning
- Missing required values
- Systems interpreting the same field differently
- Payload format undocumented
- Integration code depending on fields it does not actually need
How to Improve
Send the minimum useful information.
Document field names, types, required values, and meaning.
Do not include sensitive data simply because it is conveniently available.