Skip to main content

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​

Successful preview output and exact body. The errors array is empty. Missing source values are reported separately in missingPaths.