> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trackplay.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a sample trigger payload

> Returns one representative payload for a trigger, wrapped in the same envelope a real signed delivery uses. Zapier uses this to build its field-mapping UI, and as a fallback so a user can set up a Zap's action before any real event has fired.

Requires a token with the `webhooks:write` scope.



## OpenAPI

````yaml /api-reference/openapi.json get /zapier/triggers/{event}/sample
openapi: 3.1.0
info:
  title: TrackPlay API
  description: >-
    Send conversions and events to TrackPlay, and read them back. Authenticated
    with scoped tokens you mint in the dashboard.
  version: 1.0.0
servers:
  - url: https://app.trackplay.io/api/v1
    description: App API. Conversions, videos, webhooks.
  - url: https://e.trackplay.io
    description: Events API. High-volume event ingest.
security:
  - bearerAuth: []
tags:
  - name: Videos
    description: Create, read, update, and delete videos, and read workspace metadata.
  - name: Video settings
    description: Save a settings draft, publish it live, and read or restore past deploys.
  - name: Uploads
    description: >-
      Upload a source video file in one request or in resumable chunks, and poll
      its processing status.
  - name: Captions and chapters
    description: >-
      Manage caption tracks, chapter markers, AI-generated segments, and CTA
      cards on a video.
  - name: Playlists
    description: Group videos into a playlist or course, and manage the videos inside it.
  - name: Webhooks
    description: Subscribe a URL to TrackPlay lifecycle events and test deliveries.
  - name: Zapier
    description: >-
      The REST-hook endpoints Zapier calls to connect a workspace and manage
      triggers.
  - name: Analytics
    description: Read play, retention, event, and conversion analytics for a video.
  - name: Exports
    description: Queue and download bulk analytics exports.
  - name: Conversions
    description: Report a sale or a lead, from your own server or from a browser fallback.
  - name: Events
    description: Send a custom event tied to a viewer's session.
  - name: Identity
    description: Resolve a viewer's identity from the page, with no token required.
paths:
  /zapier/triggers/{event}/sample:
    get:
      tags:
        - Zapier
      summary: Get a sample trigger payload
      description: >-
        Returns one representative payload for a trigger, wrapped in the same
        envelope a real signed delivery uses. Zapier uses this to build its
        field-mapping UI, and as a fallback so a user can set up a Zap's action
        before any real event has fired.


        Requires a token with the `webhooks:write` scope.
      operationId: zapierTriggerSample
      parameters:
        - name: event
          in: path
          required: true
          schema:
            type: string
            enum:
              - new_lead
              - new_conversion
              - play_milestone
              - split_test_winner
              - cta_clicked
              - video_viewed
          description: A trigger key from `GET /zapier/triggers`.
      responses:
        '200':
          description: The sample payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZapierSampleResponse'
        '401':
          description: >-
            `AUTH_REQUIRED`: no token sent. `INVALID_TOKEN`: the token is
            invalid, expired, or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: '`INSUFFICIENT_SCOPE`: the token does not carry `webhooks:write`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: '`unknown_trigger`: `event` is not one of the six trigger keys.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZapierUnknownTriggerError'
        '429':
          description: Rate limited. 60 requests per minute per token.
components:
  schemas:
    ZapierSampleResponse:
      type: array
      description: >-
        A one-element array holding the sample envelope. Zapier's
        polling-trigger contract expects an array, even though there is only
        ever one sample.
      items:
        $ref: '#/components/schemas/ZapierSampleEnvelope'
      minItems: 1
      maxItems: 1
    ApiError:
      type: object
      description: The error shape the app API returns on a failed read or export.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                A stable error code, e.g. `INSUFFICIENT_SCOPE`,
                `VIDEO_NOT_FOUND`, `EXPORT_NOT_FOUND`.
            message:
              type: string
              description: What went wrong, in plain English.
    ZapierUnknownTriggerError:
      type: object
      properties:
        error:
          type: string
          examples:
            - unknown_trigger
    ZapierSampleEnvelope:
      type: object
      properties:
        id:
          type: string
          examples:
            - sample_new_lead
        event:
          type: string
          description: The underlying lifecycle event name.
        workspace_id:
          type: integer
        created_at:
          type: string
          format: date-time
        data:
          type: object
          additionalProperties: true
          description: The event's payload. Shape depends on the trigger.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A scoped token minted in **Settings → API tokens**. Send it as
        `Authorization: Bearer tplt_…` or `X-API-Key: tplt_…`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.