Preview a draft webhook payload mapping
POST/api/webhooks/:id/preview
x-audience: "management"
x-required-scope: "webhooks:read"
Evaluates a draft against a supplied sample object without saving or sending. Endpoint must belong to the authenticated account. Null mapping returns the standard body. Missing optional fields are reported in missingPaths, separate from validation errors.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 503
Successful preview output and exact body. The errors array is empty. Missing source values are reported separately in missingPaths.
Malformed input, invalid mapping, or evaluation failure. Mapping errors include field-level errors with path and message. Evaluation failures return null output and body.
Missing, invalid or revoked credentials.
Required scope or account access missing.
Endpoint not found in this account.
Shared client-IP or account request allowance exhausted. Retry after the indicated number of seconds. Browser authentication errors can use a different response format.
Response Headers
no-store
Seconds to wait before retrying.
Request limiting cannot be enforced. Retry later with backoff.
Response Headers
no-store