GoliathDevelopersGet an API key
Reference/Workflowsgenerated from the gateway manifest

listEventWorkflowPayloadSamples

The example payloads an EVENT workflow has received or been given.

POST/api/v1/callREADreadruns as the key's owner
View as Markdown

The example payloads an EVENT workflow has received or been given (what its sender POSTs), to map trigger fields from. Empty for any other domain. A run: id belongs to a run and cannot be deleted.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "listEventWorkflowPayloadSamples",
    "variables": {
      "workflowGroupId": "<workflowGroupId>"
    }
  }'
import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.workflows.listEventWorkflowPayloadSamples({
  workflowGroupId: '<workflowGroupId>'
})
const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    operationId: 'listEventWorkflowPayloadSamples',
    variables: {
      workflowGroupId: '<workflowGroupId>'
    }
  }),
})
const { data, errors } = await res.json()

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

workflowGroupIdID!required

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape
{
  "data": {
    "workflowAutomationsQuery": {
      "eventWorkflowPayloadSamples": [
        {
          "id": "<ID>",
          "source": "WEBHOOK",
          "payload": "…",
          "receivedAt": "2026-01-01T00:00:00.000Z"
        }
      ]
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

Behaviour

A read. It rejects an Idempotency-Key header with 400 bad_request.

READlistWorkflowsREADgetWorkflowREADgetWorkflowVersionGraphREADlistWorkflowRunsREADgetContentTemplateREADlistContentTemplates