Get a transform
GET/v1/transforms/{transformId}preview
Get a transform: its draft and live code or managed pin, and the destinations and sources that link it. A destination transform needs destinations:read, a source transform sources:read; without it the transform reads as not found.
Path parameters
transformIdstring RequiredA transform ID, starting with tfm_.
Returns
The query result.200
dataobject RequiredCode that destinations or sources link: one saved draft and the one live code, or a managed pin.
idstring RequiredA transform ID, starting with tfm_.
kindstring Requireddestination: maps an event payload to the request a destination receives. source: builds an event from the request a source receives. A transform links only to resources of its kind.
Allowed values: "destination", "source"
namestring RequiredA name for people.
1 to 120 characters
managedobject | null RequiredThe managed transform version this transform runs in place of code of its own.
draftobject | null RequiredThe saved draft. Saving it changes nothing until it is published. Null when pinned.
liveobject | null RequiredThe published code every linked destination and source runs. Null until the draft is first published, or when pinned.
unpublishedChangesboolean RequiredTrue when the draft is not the live code: it was never published, or it was saved since.
destinationsobject[] RequiredThe destinations that link this transform, by name.
Show child attributesHide child attributes
idstring RequiredA destination ID, starting with dst_.
namestring RequiredIts name.
sourcesobject[] RequiredThe sources that link this transform, by name.
Show child attributesHide child attributes
idstring RequiredA source ID, starting with src_.
namestring RequiredIts name.
createdAtstring (date-time) RequiredISO 8601 timestamp.
updatedAtstring (date-time) RequiredISO 8601 timestamp.
Example
curl -X GET "https://api.payloadpuffin.com/v1/transforms/$TRANSFORMID" \
-H "Authorization: Bearer $PAYLOADPUFFIN_API_KEY"{
"data": {
"id": "id",
"kind": "destination",
"name": "name",
"managed": {
"provider": "provider",
"version": 1
},
"draft": {
"code": "code",
"savedAt": "savedAt"
},
"live": {
"code": "code",
"publishedAt": "publishedAt"
},
"unpublishedChanges": true,
"destinations": [
{
"id": "id",
"name": "name"
}
],
"sources": [
{
"id": "id",
"name": "name"
}
],
"createdAt": "createdAt",
"updatedAt": "updatedAt"
}
}Errors
Errors use application/problem+json. The code member is stable; branch on it rather than on title or detail.
4XXapplication/problem+jsonThe request was rejected.