Use the API, webhooks and Zapier

Before you start

API keys, webhooks and Zapier are on the Team plan. They belong to the workspace, and only owners and admins can manage them.

Go to Settings → Integrations and open the API & webhooks card in the AI & automation group. On another plan the card explains this and links to See plans.

Create an API key

1. 1
   In the API & webhooks card, type a name under New key, such as the tool that will use it, and choose Create key.
2. 2
   Copy the key straight away. It starts with veew_live_ and is shown only once. Veew keeps only a hash, so it can't show the key again.
3. 3
   Store it in the tool that will call Veew. The card lists each key with when it was created and last used.

Call the REST API

The base URL is https://veew.ai/api/v1. Send the key in an Authorization header: Authorization: Bearer veew_live_ followed by the rest of your key. For example:

curl -H "Authorization: Bearer veew_live_..." "https://veew.ai/api/v1/documents?status=accepted&limit=5"

Each key can make 60 requests a minute. A list returns at most 50 items. Errors come back as JSON with an error sentence and a code, such as unauthorized (401), plan_required (403), not_found (404) or rate_limited (429).

• GET /me

  What it does

  The key's member and workspace. Handy for checking a key works

• GET /deals

  What it does

  List deals, most recent activity first. Takes query and limit

• GET /deals/:id

  What it does

  One deal with its details, brief, meetings and documents

• POST /deals

  What it does

  Create a deal from company_name and optional company, contact, deal and notes. Returns the existing deal for a company you already have

• GET /documents

  What it does

  List documents. Filter by deal_id, status (draft, live, accepted, expired, archived) or query

• GET /documents/:id

  What it does

  One document. Add blocks=1 for its full content

• POST /documents

  What it does

  Create a document from a template under a deal. Set draft to true to have Veew write the copy, which takes up to a minute

• POST /documents/:id/draft

  What it does

  Have Veew draft or revise a document, with optional instructions. Allow 90 seconds

• GET /documents/:id/insights

  What it does

  Opens, visitors, sections read, countries, devices and recent activity

• GET /templates

  What it does

  List templates. The template value is what POST /documents takes

• GET /templates/:ref

  What it does

  One template's fields and sections

• POST /meetings

  What it does

  Add meeting notes to a deal from deal_id and notes, with an optional title and occurred_at

Add a webhook endpoint

A webhook sends events to your own server as they happen. Veew POSTs JSON to your URL.

1. 1
   In the API & webhooks card, under Webhook endpoints, enter an Endpoint URL. It must be an https:// URL on a public host. A Name is optional.
2. 2
   Tick the Events you want. document.accepted is ticked to start with.
3. 3
   Choose Add endpoint, then copy the Signing secret. It is shown only once, and your receiver needs it to verify deliveries.
4. 4
   Choose Send a test event on the endpoint. Veew sends a ping event at once and tells you the response it got.

Retries, the delivery log and switching off

Any 2xx response counts as delivered. Veew waits 10 seconds for a reply and doesn't follow redirects. If a delivery fails, Veew retries it for about a day, waiting longer between each try, then gives up.

If an endpoint fails 20 times in a row, Veew switches it off and emails the person who added it. Events aren't queued while it is off. Once your receiver is back, choose Switch on to start it again and reset the count. You can also choose Switch off or Remove yourself. Removing an endpoint deletes its delivery log too.

Recent deliveries in the card lists the latest 25, each with its event, endpoint, response and status: Pending, Retrying, Delivered or Gave up. Choose Re-send to try a delivery again now.

Connect Zapier

Zapier uses an API key, so it is on the Team plan and an owner or admin creates the key.

1. 1
   Create an API key in the API & webhooks card, named something like Zapier.
2. 2
   In Zapier, make a Zap and search for Veew as the trigger or action app.
3. 3
   Paste the key when Zapier asks you to connect Veew.