> ## 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. # Subscribe a Zap to a trigger > Creates a REST-hook subscription: under the hood this is a normal, signed webhook subscription scoped to one trigger's event, with its URL pointed at the Zap's hook. Zapier calls this automatically when a user turns a Zap on; you would only call it directly if you were building your own Zapier-style polling integration against the same trigger catalogue. Requires a token with the `webhooks:write` scope. ## OpenAPI ````yaml /api-reference/openapi.json post /zapier/subscribe 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/subscribe: post: tags: - Zapier summary: Subscribe a Zap to a trigger description: >- Creates a REST-hook subscription: under the hood this is a normal, signed webhook subscription scoped to one trigger's event, with its URL pointed at the Zap's hook. Zapier calls this automatically when a user turns a Zap on; you would only call it directly if you were building your own Zapier-style polling integration against the same trigger catalogue. Requires a token with the `webhooks:write` scope. operationId: zapierSubscribe parameters: - name: Idempotency-Key in: header required: false schema: type: string description: >- Retry-safe key. The first response for a given key is cached for 24 hours and replayed on a repeat, with `Idempotency-Replayed: true` set. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ZapierSubscribeRequest' responses: '201': description: 'Subscribed. Keep `id`: you need it to unsubscribe.' content: application/json: schema: $ref: '#/components/schemas/ZapierSubscribeResponse' '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' '422': description: Validation failed. `event` must be one of the six trigger keys. content: application/json: schema: $ref: '#/components/schemas/ValidationError' '429': description: Rate limited. 60 requests per minute per token. components: schemas: ZapierSubscribeRequest: type: object required: - target_url - event properties: target_url: type: string format: uri maxLength: 2048 description: >- The Zap's hook URL. TrackPlay POSTs a signed delivery here on every matching event. event: type: string enum: - new_lead - new_conversion - play_milestone - split_test_winner - cta_clicked - video_viewed description: Which trigger to subscribe to. ZapierSubscribeResponse: type: object properties: id: type: integer description: Echo this back on `DELETE /zapier/subscribe/{id}` to unsubscribe. event: type: string description: >- The underlying lifecycle event name this subscription was created for. 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. ValidationError: type: object description: >- Laravel's default validation-failure body. `errors` maps each invalid field to its list of messages. properties: message: type: string examples: - The given data was invalid. errors: type: object additionalProperties: type: array items: type: string 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.