Skip to main content
POST
Create a sync source

Authorizations

Authorization
string
header
required

A Contact Button scoped bearer key. Send Authorization: Bearer <token>. Token abilities are enforced independently of workspace membership; both checks must pass. Interactive MCP clients use registered OAuth applications, Authorization Code + PKCE, audience-bound tokens, and explicit workspace grants. Personal Sanctum tokens remain supported.

Path Parameters

workspace
string<uuid>
required
list
string<uuid>
required

Body

application/json
provider
enum<string>
required

Use webpage for one public HTML page or bounded same-origin website discovery through Contact Button's SSRF-protected ingestion boundary.

Available options:
rss,
markdown,
webpage,
github,
google_drive,
onedrive
name
string
required
source_url
string<uri> | null
configuration
object
access_token
string
write-only
mode
enum<string>
Available options:
import,
continuous
trusted_auto_publish
boolean
default:false
sync_frequency
enum<string>

Must be included in the workspace plan. Preview-only sources default to manual and cannot be synced.

Available options:
manual,
hourly,
daily

Response

201 - application/json

Successful data envelope.

data
any
required
meta
object
required