ConverterHQDevelopers
Documentation

Zapier

Automate file conversion with first-party Zapier triggers and actions.

The ConverterHQ Zapier app uses OAuth and the same public REST, capability and webhook contracts as custom integrations.

Authentication

Connect your ConverterHQ account through HQTools OAuth. Grants are scoped and revocable; no API-key copy/paste is required. Conversion actions include File-write permission because simple conversion creates an owned input File before execution.

Actions

Convert a File, create/get/cancel/retry Jobs, run Workflows, estimate conversions and create signed conversion URLs. Format and option fields are loaded dynamically from the live capability graph, so a Zap cannot silently select settings unsupported by its pair.

Instant triggers

Job/conversion success and failure triggers are backed by ConverterHQ's durable webhook system rather than Zapier-specific polling. Delivery remains at least once, so downstream steps should use a stable business identifier where duplicate side effects matter.

Workflow data

The Run Workflow action accepts validated variables, metadata and a client reference ID. Map the trigger's stable source-event ID into the required business_event_id field. ConverterHQ hashes that business identity into the idempotency key, so a transport retry reuses the intended run while a later source event creates new work.

Operating a Zap

Convert a File retries a still-processing conversion with the same business-event idempotency key instead of returning an unfinished file to the next step. For long fan-out workflows, the completion webhook trigger remains the preferred boundary between execution and downstream delivery.

Use sandbox credentials while building, then reconnect the Zap to production deliberately. Persist the ConverterHQ Job ID in records that require supportability, and inspect the webhook delivery history when an instant trigger appears delayed.