Skip to main content
POST
Subscribe a Zap to a trigger

Authorizations

Authorization
string
header
required

A scoped token minted in Settings → API tokens. Send it as Authorization: Bearer tplt_… or X-API-Key: tplt_….

Headers

Idempotency-Key
string

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.

Body

application/json
target_url
string<uri>
required

The Zap's hook URL. TrackPlay POSTs a signed delivery here on every matching event.

Maximum string length: 2048
event
enum<string>
required

Which trigger to subscribe to.

Available options:
new_lead,
new_conversion,
play_milestone,
split_test_winner,
cta_clicked,
video_viewed

Response

Subscribed. Keep id: you need it to unsubscribe.

id
integer

Echo this back on DELETE /zapier/subscribe/{id} to unsubscribe.

event
string

The underlying lifecycle event name this subscription was created for.