Skip to main content
POST
Create Handoff Connection

Headers

x-anyreach-org
string | null

Organization ID for user PATs (pat_ prefix tokens)

Body

application/json

Body for POST /handoff/connections.

name
string
required

Human-readable label for this connection

auth_details
HandoffAuthDetails · object
required

Provider credentials — write-only, never returned

provider
string
default:gladly

Handoff provider. Only 'gladly' is supported today.

webhook_secret
string | null

Shared secret used to verify inbound webhook signatures

settings
HandoffConnectionSettings · object | null

How this helpdesk behaves — SLA timers and what context it is sent. Shared by every agent that escalates through this connection.

enabled
boolean
default:true

Response

Successful Response

A handoff connection as any caller is allowed to see it.

Explicitly modelled rather than returning the entity, so no future field added to HandoffConnection can leak a credential by default. auth_details here is the {base_url, username} pair only.

id
string
required
organization_id
string
required
provider
string
required
name
string
required
auth_details
Auth Details · object
has_webhook_secret
boolean
default:false
settings
HandoffConnectionSettings · object

How this helpdesk behaves — as opposed to how to reach it.

These sit on the connection rather than on an escalation rule because they describe the HELPDESK, not the route: how fast that team answers and what context it wants to receive. Change one here and every agent routing through this connection follows, which is the point — an SLA is not a per-agent setting.

Customer-facing copy deliberately does NOT live here. It is spoken in the agent's voice and language, and one connection is shared by every agent in the org, so a shared waiting message would put the wrong language in front of somebody. That stays on the rule.

enabled
boolean
default:true
created_at
string<date-time> | null
updated_at
string<date-time> | null
created_by
string | null
modified_by
string | null