Conversions API and public API docs

  • Integration
  • New Feature

Record quotes, sales and your own conversions from any system, and read the docs at hiremav.com/api.

Your CRM, rater or management system can now tell Mav when a contact was quoted or sold. Find the contact by phone, then post the conversion. Mav marks the contact, records it on the timeline, and sends it to any webhook that listens for it.

The public documentation lives at hiremav.com/api. It has a request and response for every endpoint, a full example, and the errors you can expect. The same page documents the webhooks Mav sends you.

Read the API docs Outbound webhooks and the API

Improvements

  • Accounts can define their own conversions, like Application submitted, alongside Quoted and Sold. A custom conversion can complete the engagement or leave it running.
  • Outbound webhooks can subscribe to a new Custom Conversion event.

API changes

  • GET /api/v3/contacts/find?phone= finds a contact by phone number.
  • GET /api/v3/contacts/{id} returns one contact.
  • GET /api/v3/conversions lists your account's conversions.
  • POST /api/v3/conversions/{id}/events records a conversion for a contact. Recording it twice returns the first record instead of making a second.
  • The docs at /api now cover outbound webhooks: the payload, its fields, the Bearer header, delivery and retries, and every event you can subscribe to.
  • Every section of the docs is also served as Markdown, at /api.md and /api/<section>.md, with a Copy for LLM button.

Never miss an update.

Get every update delivered, the day it ships.

Subscribe to changelog updates

Subscribe using your favorite RSS reader.

https://hiremav.com/changelog/feed.xml