Skip to navigation
Get started

Introduction

Use Sailor’s public API to configure the phone-system outcomes agents can apply during and after calls.

You can create action buttons, create post-call dispositions, move contacted people between Smart Lists, and receive webhooks when an action runs.

The loop has three parts: your backend configures outcomes, Sailor shows them to agents, and Sailor sends signed, durably retried events back when actions run.

What You Can Build

Outcome configuration

Create and manage the labels agents see during calls and after calls.

Smart List movement

Add a contacted person to a Smart List, or remove them from every list or selected lists.

Outcome webhooks

Receive the call, outcome, scope, and destination details when an action runs.

Field-level reference

Use the exact request fields, response fields, validation rules, and webhook schemas.

Base URL

https://api.sailorhq.io

Supported Endpoints

MethodPathUse it for
GET/phone-system/outcomesList the outcomes configured for the workspace.
POST/phone-system/outcomesCreate a new outcome.
PATCH/phone-system/outcomes/{outcomeId}Replace an existing outcome configuration.
DELETE/phone-system/outcomes/{outcomeId}Delete an outcome.

Build against the documented endpoints in these guides and the API Reference. Undocumented paths can change without notice.

How The Loop Works

1

Authenticate from your backend

Send a bearer token with each request. Keep the token server-side.

2

Configure outcomes

Create action outcomes for in-call controls and disposition outcomes for the required post-call step.

3

Agents apply outcomes

Sailor shows those outcomes inside the phone-system workflow for the active workspace.

4

Sailor runs the destination

Depending on the outcome, Sailor can move the contacted person into a Smart List, remove them from lists, and prepare the webhook event.

5

Your backend accepts the event

Return any 2xx status after you store or enqueue the webhook payload.

Choose Your Path

Build the first loop

Create an action, receive a webhook, add a disposition, and verify the result.

Understand the model

Learn the difference between actions, dispositions, destinations, and webhook events.

Ship a receiver

Build a webhook endpoint that accepts Sailor events without blocking agents.

Check exact fields

Use the reference when you need the precise contract for an endpoint or payload.