> ## 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.

# Send a test delivery

> Sends a synthetic `webhook.test` delivery to the subscription's URL right now, signed the same way a real delivery is. Use it to confirm your endpoint is reachable and your signature verification works before relying on the real event traffic.

A non-2xx response from your endpoint still counts as delivered: check `status_code` on the 200 response. The call only fails with a 502 when the delivery could not be sent at all, for example a DNS failure or a connection timeout.

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



## OpenAPI

````yaml /api-reference/openapi.json post /webhooks/{webhook}/test
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:
  /webhooks/{webhook}/test:
    post:
      tags:
        - Webhooks
      summary: Send a test delivery
      description: >-
        Sends a synthetic `webhook.test` delivery to the subscription's URL
        right now, signed the same way a real delivery is. Use it to confirm
        your endpoint is reachable and your signature verification works before
        relying on the real event traffic.


        A non-2xx response from your endpoint still counts as delivered: check
        `status_code` on the 200 response. The call only fails with a 502 when
        the delivery could not be sent at all, for example a DNS failure or a
        connection timeout.


        Requires a token with the `webhooks:write` scope.
      operationId: testWebhook
      parameters:
        - name: webhook
          in: path
          required: true
          schema:
            type: integer
          description: The subscription's numeric ID.
      responses:
        '200':
          description: >-
            The delivery was sent. Check `status_code` to see how your endpoint
            responded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookTestSuccessResponse'
        '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: No subscription with that ID exists in this workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LaravelNotFoundError'
        '429':
          description: Rate limited. 60 requests per minute per token.
        '502':
          description: The test delivery could not be sent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookTestFailureResponse'
components:
  schemas:
    WebhookTestSuccessResponse:
      type: object
      properties:
        delivered:
          type: boolean
          examples:
            - true
        status_code:
          type:
            - integer
            - 'null'
          description: The HTTP status your endpoint returned for the test delivery.
    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.
    LaravelNotFoundError:
      type: object
      description: >-
        The default not-found body Laravel returns when a route model lookup
        fails (`findOrFail`). It carries no stable error code, unlike the app's
        own `{"error": {"code": ...}}` shape used on hand-written error paths in
        this API.
      properties:
        message:
          type: string
          examples:
            - No query results for model [App\\Models\\WorkspaceVideo] 481
    WebhookTestFailureResponse:
      type: object
      description: >-
        Returned with a 502 when the test delivery could not be sent at all (DNS
        failure, connection refused, timeout). A non-2xx response from your
        endpoint still counts as delivered: check `status_code` on the 200
        response for that case.
      properties:
        delivered:
          type: boolean
          examples:
            - false
        error:
          type: string
          description: The underlying delivery error.
  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.