Transform Preview

Dry-run delivery

Simulate a full delivery: transform payload, compute HMAC signature, build headers — without actually sending the request

post/api/v1/projects/{projectId}/transform-preview/delivery-dry-run

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/projects/{projectId}/transform-preview/delivery-dry-run
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

projectIdstring uuid required

Request body

payloadstring required

The event payload JSON to transform

transformationIdstring uuid

ID of a saved Transformation to apply (highest priority)

payloadTemplatestring

An unsaved template or script to apply. What the Transform Studio sends while you are still editing.

kind'TEMPLATE' | 'JAVASCRIPT'

The language payloadTemplate is written in. Omitted means TEMPLATE. A saved transformation brings its own and ignores this.

customHeadersstring

Custom headers JSON to merge

endpointIdstring uuid

Endpoint ID to use for HMAC signature computation

eventTypestring

Event type for X-Event-Type header

Example request

{
  "eventType": "order.created"
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.