Getting started

Quickstart

Get a sandbox key, create your first confirmation and receive the webhook. About 30 minutes, most of it reading.

This walks you through one confirmation end to end in the sandbox: you create it, play the customer, and receive the signed webhook your system would act on.

1. Get a sandbox key

Ask for a sandbox key and we'll send it with your webhook signing secret. Put both in environment variables on your server.

Check the key works by listing confirmations. A 200 with an empty list means you're in. A 401 means the key is wrong: see Authentication.

export ANYONEIN_KEY="your-sandbox-key"

curl https://api.anyonein.co.uk/v1/confirmations?limit=1 \
  -H "Authorization: Bearer $ANYONEIN_KEY"
# {"confirmations":[]}

const headers = { Authorization: `Bearer ${process.env.ANYONEIN_KEY}` };
const res = await fetch('https://api.anyonein.co.uk/v1/confirmations?limit=1', { headers });
console.log(res.status); // 200 (401 means the key is wrong)

headers = {"Authorization": f"Bearer {os.environ['ANYONEIN_KEY']}"}
res = requests.get("https://api.anyonein.co.uk/v1/confirmations?limit=1", headers=headers)
print(res.status_code)  # 200 (401 means the key is wrong)

<?php
$ch = curl_init('https://api.anyonein.co.uk/v1/confirmations?limit=1');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ANYONEIN_KEY')],
]);
curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE); // 200 (401 means the key is wrong)

2. Create a confirmation

Send the customer, the order date and window, and at least one item. Use "cadence": "demo" while you're testing: the steps then run about 90 seconds apart instead of days.

The response is the new confirmation, with status: "scheduled" and its plan in steps.

Tip

Add rescheduleOptions with one or two other slots. If the customer can't make the first date, the agent offers these and books the one they pick, and the confirmation ends rescheduled instead of needing a person.

curl -X POST https://api.anyonein.co.uk/v1/confirmations \
  -H "Authorization: Bearer $ANYONEIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customer": { "name": "Priya Shah", "phone": "07700 900123", "email": "priya@example.com" },
    "order": {
      "date": "2026-10-13",
      "window": { "from": "08:00", "to": "12:00" },
      "items": [{ "name": "Marlow 3-seat sofa" }]
    },
    "cadence": "demo",
    "webhookUrl": "https://example.com/webhooks/anyonein"
  }'

const res = await fetch('https://api.anyonein.co.uk/v1/confirmations', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.ANYONEIN_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    customer: { name: 'Priya Shah', phone: '07700 900123', email: 'priya@example.com' },
    order: { date: '2026-10-13', window: { from: '08:00', to: '12:00' }, items: [{ name: 'Marlow 3-seat sofa' }] },
    cadence: 'demo',
    webhookUrl: 'https://example.com/webhooks/anyonein',
  }),
});

res = requests.post(
    "https://api.anyonein.co.uk/v1/confirmations",
    headers={"Authorization": f"Bearer {os.environ['ANYONEIN_KEY']}"},
    json={
        "customer": {"name": "Priya Shah", "phone": "07700 900123", "email": "priya@example.com"},
        "order": {"date": "2026-10-13", "window": {"from": "08:00", "to": "12:00"}, "items": [{"name": "Marlow 3-seat sofa"}]},
        "cadence": "demo",
        "webhookUrl": "https://example.com/webhooks/anyonein",
    },
)

<?php
$payload = [
    'customer' => ['name' => 'Priya Shah', 'phone' => '07700 900123', 'email' => 'priya@example.com'],
    'order' => ['date' => '2026-10-13', 'window' => ['from' => '08:00', 'to' => '12:00'], 'items' => [['name' => 'Marlow 3-seat sofa']]],
    'cadence' => 'demo',
    'webhookUrl' => 'https://example.com/webhooks/anyonein',
];

3. Play the customer

Open the sandbox console. Your confirmation's email arrives first, then the text. Reply as the customer would, in your own words:

"Yes, I'll be in" confirms it.
"I'm at work but my partner Jo will sign" confirms it with a named signer.
"Tuesday's no good, any chance of Thursday?" picks one of your other slots, or asks for a different day.
"STOP" opts them out.

Or ignore the text and answer the simulated call when it rings. If nobody answers anything, the confirmation ends unreachable a couple of minutes after the last step.

Note

In the sandbox nothing reaches a real phone or inbox, and every step has "live": false. Replying through the API is on the roadmap; for now the console is how you play the customer.

4. Receive the webhook

When there's an outcome, AnyoneIn POSTs a confirmation.updated event to your webhookUrl. Verify the X-AnyoneIn-Signature header, then act on data.status.

Your endpoint must be public and use https. For local testing, a tunnel such as ngrok or Cloudflare Tunnel works well. The full details are in Webhooks.

POST /webhooks/anyonein HTTP/1.1
Content-Type: application/json
X-AnyoneIn-Signature: sha256=9f2c41e8d0b7a6f3c5e1d2b4a7968f0e3c1b5a2d4e6f8091a3b5c7d9e1f20468

{"type":"confirmation.updated","data":{"id":"cf_7d2a9c41e0b3f658","status":"confirmed",…}}

if (event.type === 'confirmation.updated') {
  const c = event.data;
  if (c.status === 'confirmed') markReadyForDispatch(c.externalId, c.outcome.signerName);
  if (c.status === 'rescheduled') moveBooking(c.externalId, c.order.date, c.order.window);
  if (c.status === 'action_needed' || c.status === 'unreachable') flagForTeam(c.externalId, c.outcome.summary);
}

Going live

Before you switch to your live key:

Send "cadence": "standard". It's what real customers should get: email three days out, a text two days out and a call the day before, only in sensible hours.
Set brand on every request, so messages carry your name, colour, support email and tone.
Store the returned id against your order, and send your own order number as externalId.
Make your webhook handler safe to run twice for the same event (see handling deliveries).
Decide who picks up action_needed and unreachable confirmations before dispatch.

Base URL https://api.anyonein.co.uk/v1 is a placeholder until the production domain is confirmed. Found a mistake? Tell us.

#1. Get a sandbox key

#2. Create a confirmation

#3. Play the customer

#4. Receive the webhook

#Going live

1. Get a sandbox key

2. Create a confirmation

3. Play the customer

4. Receive the webhook

Going live