Render a payload template against a canonical sample event (preview pane)
POST
/webhook-endpoints/{id}/preview
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
Webhook endpoint ID
Request Bodyrequired
Section titled “Request Bodyrequired”object
payloadFormat
UI affordance for the payload shape (standard | slack | teams | custom).
string
payloadTemplate
required
Body template (JSON string) with {{ path }} placeholders to render.
string
headerTemplates
Header name → template string map to render.
object
key
additional properties
string
contentType
Content-Type for the rendered body.
string
eventType
required
Event type whose canonical sample event drives the preview (e.g. reconciliation.run.completed).
string
Responses
Section titled “Responses”object
body
required
Rendered delivery body.
string
headers
required
Rendered header name → value map.
object
key
additional properties
string
contentType
required
Content-Type of the rendered body.
string
Template is invalid (bad JSON / placeholder)
Endpoint not found