Developers
Developers · Coavon's app on Zapier

Coavon's Zapier API

This is the API that Coavon's app on Zapier uses. Most people never need it: they connect in Zapier and pick triggers and actions there. It is documented here for Zapier and for anyone curious about exactly what the app can do.

Included on Starter and above

What it does

Sign-in

OAuth 2.0 with PKCE ("Sign in with Coavon"), or a Workplace API key. Every request acts as one person in one organization.

Lists

Projects, people, pipelines, stages and record types for the drop-downs in a Zap.

Instant triggers

Subscribe a Zapier address to an event and Coavon posts to it the moment the event happens.

Actions

Create and update tasks and records, comment, add notes, move records between stages and add calendar events.

Set it up

  1. Base address: https://workplace.coavon.com/api/zapier/<action>. Requests and answers are JSON.
  2. Authorize at https://workplace.coavon.com/api/oauth/authorize (scope coavon, PKCE S256) and exchange the code at https://workplace.coavon.com/api/oauth/token, which also refreshes tokens. A Workplace API key (coavon_sk_…) works too.
  3. Send the token with each request: Authorization: Bearer <token>.

Endpoints

  • GET me: who is connected. Answers id, name, organization_id and organization.
  • GET projects, GET members, GET pipelines, GET stages?pipeline_id= and GET record_types: lists of { id, name } for drop-downs, limited to what the person can see.
  • GET recent?event=: the newest examples of a trigger (up to 25). Optional filters: project_id, pipeline_id, record_type.
  • GET find_tasks?title=&project_id=: tasks whose title matches, exact matches first. GET find_records?email=&name=: records by email, otherwise by name. These are for searches planned for a later version of the Zapier app.
  • POST hooks with { event, target_url, project_id?, pipeline_id?, record_type? }: start an instant trigger. Answers 201 with { id }. Events: task_created, task_completed, task_status_changed, record_created, record_stage_changed. The target must be a https://hooks.zapier.com/ address; up to 50 per person.
  • DELETE hooks?id=: stop an instant trigger. Always allowed, whatever the plan.
  • When a trigger's event happens, Coavon sends a POST to its target with the task or record as JSON (the same shape as recent). A 410 answer removes the subscription.
  • POST create_task (title, optional project_id, description, assignee_id, priority, due_date, due_time) and POST update_task (task_id plus any of those and status). Both answer the task.
  • POST add_task_comment (task_id, text): answers the task.
  • POST create_record (record_type, first_name, last_name, name, email, phone, company, job_title, website, notes, optional pipeline_id, stage_id, value) and POST update_record (record_id plus the same details). A record with the same email is updated rather than added twice. Both answer the record.
  • POST move_record_stage (record_id, pipeline_id, stage_id, optional value) and POST add_record_note (record_id, note): answer the record.
  • POST create_event (title, start_time, optional end_time, all_day, location, description, share_with_org): answers the event.
  • A task comes back with task_id, title, description, status, status_key, priority, due_date, due_time, project_id, project_name, assignee_id, assignee_name, created_at, completed_at and url. A record comes back with record_id, record_type, name, first_name, last_name, email, phone, company, job_title, website, created_at and url; stage events add pipeline_name, stage_name and previous_stage_name.
  • Errors answer { error } with a sentence a person can read: 400 for a missing or wrong field, 401 when the sign-in has expired, 402 when the plan does not include API access, 403 when the person's role is not allowed, and 429 past the day's allowance.

How it works, and what Coavon can see

  • Every request acts as the person who connected, in the organization they chose when signing in. Coavon checks they are still a member, that their role may use AI tools and connected apps, and that the plan includes API access.
  • A sign-in made for Zapier works only here, and a sign-in made for an AI assistant does not work here.
  • Each request counts toward the organization's daily allowance, shared with the AI assistants and the API. Instant trigger messages do not count.

More in our privacy policy and on how we keep your data safe. Questions? Write to hello@coavon.com.

Questions

No. Connect Coavon in Zapier and choose triggers and actions there. This page describes what happens underneath.

Try Coavon with your team

Every app, on one account. Your first 14 days are on Pro, with no card needed. After that it stays free for one person.

See pricing
Already have an account?