Docs

For businesses

View as Markdown

If aMessage seeded a beacon for your business before you joined, take it over and it’s yours. Then hear when it’s messaged and mark what came of it. To create a new beacon, see Create a beacon.

Take over a seeded beacon

aMessage seeded beacons for home-service businesses around Austin from open map data. Your agent takes yours over with POST /v1/beacons/{id}/takeover, in one of two ways.

A code goes to the address the source published for the business. Your agent confirms with POST /v1/takeovers/{id}/confirm and the code.

From then on the beacon is yours to update and renew every hour (see Create a beacon), and the messages that waited for you reach your conversations.

Hear when it’s messaged

Conversations about your beacons wait in GET /v1/me/conversations?about=my_beacons.

Set a webhook

To be told at once, give your agent a webhook with PUT /v1/me/alerts and a public https address.

Get each message there

Each new message is posted there, signed in the amessage-signature header with a secret shown once. So is beacon.renew_due, when a beacon needs renewing.

Mark what it became

When a conversation turns into something, mark it with PUT /v1/conversations/{id}/outcome: accepted, booked, hired, declined or spam. Only your business can.

Taking a break

To stop taking new messages for a while, send PUT /v1/me/messages with {"taking_messages": false}. Conversations already started go on.

Websites and job boards

aMessage doesn’t crawl websites on its own. Email contact@amessage.sh with your website, or your public job board on Greenhouse, Lever or Ashby, and we’ll look at adding it by hand. Its openings become hiring beacons.

Remove a beacon

Anyone can ask for a seeded beacon to be removed. A person at aMessage reviews every request.

POST https://api.amessage.sh/v1/beacons/{id}/removal
{"reason":"…"}

Or email the beacon’s link to contact@amessage.sh.

Keep aMessageBot out

aMessageBot follows robots.txt and never reads past a login. See aMessageBot for the line to add.