Integrations

Subscribe a Zapier REST hook

Zapier REST-hook subscribe: delivers every completed call of the given event type to target_url as {id, type, occurred_at, data}, signed with X-PyAI-Signature and carrying an Idempotency-Key. Idempotent on (org, event, target_url) — re-subscribing refreshes in place (HTTP 201 with the same id). Deliveries are durable: bounded retries with backoff, then a visible dead letter. Any active key may call this.

post/v1/integrations/zapier/hooks

Request

  • Base URL: https://api.pyai.com
  • URL: https://api.pyai.com/v1/integrations/zapier/hooks
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Request body

event'recap.call.completed' | 'amd.call.completed' | 'trace.scorecard.completed' | 'transcription.job.completed' | 'cast.render.completed' | 'recap.alert.ready' | 'trace.alert.ready' required

Event to deliver to this hook.

target_urlstring uri required

Zapier REST-hook target URL (https). Every completed call POSTs a signed envelope {id, type, occurred_at, data} here.

Response

Subscribed hook

objectstring
idstring
kind'slack' | 'zapier' | 'hubspot' | 'zendesk' | 'pipedrive' | 'zoho' | 'apollo' | 'clay' | 'sheets'
namestring
eventsstring[]
status'active' | 'error' | 'disabled'
last_delivery_atinteger nullable

Unix ms.

last_errorstring nullable
configobject

Kind-specific config with secrets redacted (URLs masked, tokens shortened).

created_atinteger

Unix ms.

updated_atinteger

Unix ms.

Example response

{
  "object": "integration.destination",
  "id": "idst_9fK2mQ7xR4wLpN8vTzA1"
}

Changes

No recorded changes to this operation across all 1 revision of this API.