> ## Documentation Index
> Fetch the complete documentation index at: https://docs.signalproptech.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> From a dev key to your first webhook.

> [!NOTE]
>
> During the beta these calls answer `501 not_available_yet`. The steps describe them as they'll work once live.

## 1. Get a dev key

Ask us for one. You'll get a key for a test agency on our development environment, and the address to call. Tell us
the mobile numbers your team will test with: the development environment sends real WhatsApp messages, so it only
messages those numbers.

```bash theme={null}
export SIGNAL_API="<the development address we sent you>"
export SIGNAL_KEY="<your dev key>"
```

## 2. Register your webhook

```bash theme={null}
curl -X PUT "$SIGNAL_API/webhook" \
  -H "Authorization: Bearer $SIGNAL_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://your-system.example.com/hooks/signal/agency-214", "events": ["*"]}'
```

The response contains your signing `secret`, once. Store it.

## 3. Send yourself a test event

```bash theme={null}
curl -X POST "$SIGNAL_API/webhook/test" -H "Authorization: Bearer $SIGNAL_KEY"
```

Check the signature as described in [Webhooks](https://docs.signalproptech.com/webhooks.md), then answer with any 2xx.

## 4. Send a viewing

```bash theme={null}
curl -X POST "$SIGNAL_API/viewings" \
  -H "Authorization: Bearer $SIGNAL_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "external_id": "vw_1",
        "status": "booked",
        "scheduled_at": "<tomorrow, e.g. 2026-12-10T14:30:00+00:00>",
        "transaction_type": "sale",
        "contact": {"first_name": "Test", "phone": "<one of your test numbers>"},
        "property": {"ref": "TEST-1", "address": "1 Test Street"}
      }'
```

Set `scheduled_at` to a time tomorrow: a viewing we first hear of more than two hours after its start never triggers feedback.

The afternoon before, that number gets a reminder. On the evening of the viewing it's asked for feedback, and once they answer you receive `viewing.feedback_captured`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.