Quickstart

This quickstart builds the smallest complete phone-system loop: create an action called Interested, receive the webhook when an agent applies it, then add a post-call disposition so the workflow has a required final classification.

You will finish with:

• One action outcome agents can use during a call.
• One signature-verifying webhook receiver that returns 2xx.
• One disposition outcome that turns on the post-call disposition step.

Prerequisites

• A Sailor API key created by an owner or admin in Settings → Integrations → API access. Production keys begin with sl_live_ and are revealed once.
• A Smart List ID from the workspace you want to update.
• An HTTPS endpoint that can receive POST requests.
• A webhook signing secret created in Settings → Integrations → Webhook signing.

1. List Existing Outcomes

Start by reading the current configuration.

$
curl https://api.sailorhq.io/phone-system/outcomes \
>
  -H "Authorization: Bearer $SAILOR_API_TOKEN"

The response includes disposition_popup_enabled. It becomes true when at least one post-call disposition outcome is configured.

2. Create An Action Outcome

Action outcomes are available during a live call. They require a webhook_url because Sailor posts an event when the action runs.

$
curl https://api.sailorhq.io/phone-system/outcomes \
>
  -X POST \
>
  -H "Authorization: Bearer $SAILOR_API_TOKEN" \
>
  -H "Idempotency-Key: $SAILOR_REQUEST_KEY" \
>
  -H "Content-Type: application/json" \
>
  -d '{
>
    "outcome_name": "Interested",
>
    "outcome_type": "action",
>
    "order": 10,
>
    "destination_type": "smart_list",
>
    "destination_id": "00000000-0000-4000-8000-000000000000",
>
    "webhook_url": "https://example.com/sailor/outcomes"
>
  }'

Sailor returns 201 Created with the created outcome and the current disposition_popup_enabled value.

1
{
2
  "ok": true,
3
  "outcome": {
4
    "outcome_id": "00000000-0000-4000-8000-000000000001",
5
    "outcome_name": "Interested",
6
    "outcome_type": "action",
7
    "order": 10,
8
    "destination_type": "smart_list",
9
    "destination": {
10
      "destination_type": "smart_list",
11
      "destination_id": "00000000-0000-4000-8000-000000000000",
12
      "destination_name": "Follow up"
13
    },
14
    "webhook_url": "https://example.com/sailor/outcomes",
15
    "created_at": "2026-06-25T00:00:00.000Z",
16
    "updated_at": "2026-06-25T00:00:00.000Z"
17
  },
18
  "disposition_popup_enabled": false
19
}

3. Receive The Webhook

Your endpoint should accept a JSON body and return any 2xx status.

1
import express from "express";
2
3
const app = express();
4
5
app.post("/sailor/outcomes", express.raw({ type: "application/json" }), async (req, res) => {
6
  // Verify X-Sailor-Signature against req.body's exact bytes before parsing.
7
  // See the complete constant-time example in the Webhooks guide.
8
  const payload = JSON.parse(req.body.toString("utf8"));
9
10
  // Store or enqueue the event before returning 2xx.
11
  console.log("Sailor outcome received", {
12
    outcome: payload.outcome?.outcome_name,
13
    call: payload.call?.call_id,
14
    destination: payload.destination?.destination_type,
15
  });
16
17
  res.sendStatus(204);
18
});
19
20
app.listen(3000);

4. Add A Post-Call Disposition

Disposition outcomes are shown after a call. Use them for required post-call classification.

$
curl https://api.sailorhq.io/phone-system/outcomes \
>
  -X POST \
>
  -H "Authorization: Bearer $SAILOR_API_TOKEN" \
>
  -H "Idempotency-Key: $SAILOR_REQUEST_KEY" \
>
  -H "Content-Type: application/json" \
>
  -d '{
>
    "outcome_name": "Not Qualified",
>
    "outcome_type": "disposition",
>
    "order": 20,
>
    "destination_type": "none"
>
  }'

After this, GET /phone-system/outcomes should return disposition_popup_enabled: true.

5. Verify The Loop

Done When

Next Steps

• Read Core concepts for outcome types and destinations.
• Use Outcomes for update and delete examples.
• Use Webhooks for payload details.
• Use Rate limits to implement bounded retries.