Zapier Test Action Example is an example object payload from Zapier, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "test-action",
"method": "POST",
"path": "/v2/actions/{action_id}/test",
"summary": "Zapier Step Test",
"requestExamples": [
{
"contentType": "application/json",
"name": "TestingAnAction",
"example": {
"data": {
"limit": 10,
"offset": 0,
"authentication": "example_QVaAreV1",
"inputs": {
"email": "me@example.com"
}
}
}
}
],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"name": "ActionTestResponse",
"example": {
"links": {
"next": null,
"prev": null
},
"meta": {
"count": 1,
"limit": null,
"offset": 0
},
"data": [
{
"Description": "A response from some example third party API related to the action",
"Source": "RFC 8259",
"Image": {
"Width": 800,
"Height": 600,
"Title": "View from 15th Floor",
"Thumbnail": {
"Url": "https://www.example.com/image/481989943",
"Height": 125,
"Width": 100
},
"Animated": false,
"IDs": [
116,
943,
234,
38793
]
}
}
]
}
},
{
"status": "403",
"contentType": "application/json",
"name": "Test-action403Example",
"example": {
"errors": [
{}
]
}
},
{
"status": "401",
"contentType": "application/json",
"name": "Test-action401Example",
"example": {
"errors": [
{}
]
}
},
{
"status": "409",
"contentType": "application/json",
"name": "Test-action409Example",
"example": {
"errors": [
{}
]
}
},
{
"status": "429",
"contentType": "application/json",
"name": "Test-action429Example",
"example": {
"errors": [
{}
]
}
},
{
"status": "503",
"contentType": "application/json",
"name": "Test-action503Example",
"example": {
"errors": [
{}
]
}
},
{
"status": "504",
"contentType": "application/json",
"name": "Test-action504Example",
"example": {
"errors": [
{}
]
}
},
{
"status": "400",
"contentType": "application/json",
"name": "MalformedRequest.",
"example": {
"errors": [
{
"status": 400,
"code": "parse_error",
"title": "ParseError",
"detail": "Malformed request.",
"source": null,
"meta": {
"source": "ZAPIER",
"full_details": {
"message": "Malformed request.",
"code": "parse_error"
}
}
}
]
}
},
{
"status": "500",
"contentType": "application/json",
"name": "AServerErrorOccurred.",
"example": {
"errors": [
{
"status": 500,
"code": "error",
"title": "APIException",
"detail": "A server error occurred.",
"source": null,
"meta": {
"source": "ZAPIER",
"full_details": {
"message": "A server error occurred.",
"code": "error"
}
}
}
]
}
}
]
}