Fire Agent Trigger
Inbound fire URL for a webhook trigger. Authenticate with the trigger’s
one-time fire token as Authorization: Bearer <secret>. The JSON body
becomes the started run’s payload variable. Supply an Idempotency-Key
(or Speechify-Delivery-Id) header to make a redelivery replay the
original run instead of starting a second one.
Authentication
AuthorizationBearer
Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.
Path parameters
trigger_id
Trigger id (prefixed external id, trigger_...).
Headers
Speechify-Version
Request
An arbitrary JSON payload, passed to the run as its payload variable.
Response headers
Speechify-Request-Id
Unique identifier for this request, present on every response (2xx and
non-2xx alike). If the caller sends a `Speechify-Request-Id` request
header the server echoes it back (sanitized and length-capped) so one
logical request can be traced end-to-end; otherwise the server generates
a fresh value. Log it on every response and quote it in support requests
- it is the stable handle that ties your observation to Speechify's
server-side logs, and it matches the `request_id` field in the error
envelope.
The legacy alias `X-Request-ID` carries the same value and is still
accepted on requests, until 2027-07-24. Prefer the un-prefixed name
(RFC 6648).
Response
The fire was accepted and a run was started (or replayed).
status
The fire's dispatch status.
run_id
The started durable run, present when dispatch succeeded.
replayed
True when a duplicate delivery replayed the original fire.
Errors
401
Unauthorized Error
404
Not Found Error
409
Conflict Error