Official Zapier integration API

This reference documents the Biqli-managed client and dedicated endpoints used by the official Zapier integration. It is intended for integration transparency, support, and Zapier platform review—not for building an unrelated OAuth app. To connect your own product, start with Build your own integration. To use the official app, read Connect Biqli to Zapier.

OAuth profile

The official confidential client uses Biqli’s standard authorization-code, refresh, connection, and revocation endpoints:

Purpose	Method and endpoint
Authorize	`GET https://biq.li/oauth/authorize`
Token exchange and refresh	`POST /api/v1/oauth/token`
Connection label	`GET /api/v1/oauth/me`
Revoke	`POST /api/v1/oauth/revoke`

Authorization codes are single-use and expire after five minutes. Access tokens expire after the configured lifetime. Refresh tokens rotate after every successful refresh; reuse revokes the connection family and its Zapier-owned subscriptions.

Fixed scopes

Scope	Access
`workspace.read`	Read the approving user and connected workspace identity
`webhooks.read`	Load representative trigger payloads
`webhooks.write`	Create and remove Zapier REST Hook subscriptions
`links.read`	Retrieve connected-workspace links
`links.write`	Create, update, upsert, and delete links and read referenced link resources
`conversions.write`	Record attributed lead and sale events

Existing connections retain their originally granted scopes. Users reconnect through Zapier when the official app adds a permission.

REST Hook endpoints

Create a subscription

POST /api/v1/integrations/zapier/webhooks
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json

{
  "target_url": "https://hooks.zapier.com/hooks/standard/REDACTED/",
  "event": "link.created"
}

The endpoint requires webhooks.write and the connected user must still be allowed to create webhooks. The target must be a publicly resolvable HTTP or HTTPS URL and unique within the connected workspace.

{
  "id": "wh_01M34EXAMPLE000000000000",
  "event": "link.created"
}

Remove a subscription

DELETE /api/v1/integrations/zapier/webhooks/{webhook}
Authorization: Bearer <ACCESS_TOKEN>

Deletion is idempotent and succeeds only for a Zapier subscription owned by the authenticated OAuth connection.

Load sample trigger data

GET /api/v1/integrations/zapier/events/{event}/sample
Authorization: Bearer <ACCESS_TOKEN>

The endpoint requires webhooks.read and returns representative records in the shape expected by a Zapier polling sample. Supported values are documented in Webhook event types.

Action endpoints

Zapier action	Scope	Method and endpoint	Canonical contract
Create Link	`links.write`	`POST /v1/integrations/zapier/links`	Create a link
Retrieve Link	`links.read`	`GET /v1/integrations/zapier/links/{link}`	Retrieve a link
Update Link	`links.write`	`PATCH /v1/integrations/zapier/links/{link}`	Update a link
Upsert Link	`links.write`	`POST /v1/integrations/zapier/links/upsert`	See below
Delete Link	`links.write`	`DELETE /v1/integrations/zapier/links/{link}`	Delete a link
Track Lead	`conversions.write`	`POST /v1/integrations/zapier/conversions/leads`	Track a lead
Track Sale	`conversions.write`	`POST /v1/integrations/zapier/conversions/sales`	Track a sale

Dedicated action endpoints accept the canonical resource payloads but use the OAuth connection to select a workspace. Internal workspace IDs are not accepted.

Upsert a link

Upsert requires external_id and long_url. It updates the link with that external ID when present or creates a new link otherwise.

{
  "external_id": "crm_contact_1842",
  "long_url": "https://example.com/customers/1842",
  "name": "Customer 1842"
}

The response includes operation: "updated" or operation: "created". Conversion actions require a stable Idempotency-Key for the logical business event. Zapier must reuse that value when retrying the same lead or sale.

Errors

Status	Meaning
`400`	Invalid OAuth request, redirect, grant, scope, or integration request
`401`	Missing, expired, revoked, or invalid OAuth credentials
`403`	Missing scope, role permission, plan entitlement, conversion setting, or webhook permission
`404`	Unsupported event or unavailable workspace resource
`409`	Conflicting external ID or resource association
`422`	Invalid subscription, link, attribution, conversion, or action payload
`429`	Request rate limit exceeded

OAuth endpoints use error and error_description. Resource and validation failures use the standard Biqli API error envelope and request ID.

GETTING STARTED

OAUTH 2.0

OFFICIAL AUTOMATION APIS

SDKs

MOBILE ATTRIBUTION

BIQLI LINKS API

Official Zapier integration API

OAuth profile

Fixed scopes

REST Hook endpoints

Create a subscription

Remove a subscription

Load sample trigger data

Action endpoints

Upsert a link

Errors

​OAuth profile

​Fixed scopes

​REST Hook endpoints

​Create a subscription

​Remove a subscription

​Load sample trigger data

​Action endpoints

​Upsert a link

​Errors

OAuth profile

Fixed scopes

REST Hook endpoints

Create a subscription

Remove a subscription

Load sample trigger data

Action endpoints

Upsert a link

Errors