Skip to main content
POST
Create a source

Authorizations

Authorization
string
header
required

Same flow; ledger:write is required for any mutation.

Body

application/json
name
string
required
Example:

"stripe"

kind
string
default:custom

Connector kind. Selects the inbound payload adapter.

default_strategy
enum<string>
default:exact
Available options:
exact,
sum_in_window
default_window_seconds
integer
default:86400
default_tolerance_minor_units
default:0

Absolute minor-unit tolerance budget. Accepts a decimal string (recommended) or an integer on write. Returned as a string.

Pattern: ^\d+$
default_account_id
string
description
string
metadata
object

Response

Source created

object
enum<string>
required
Available options:
source
id
string<uuid>
required
name
string
required
Example:

"cobo"

kind
string
default:custom
required

Connector kind. Selects the inbound payload adapter.

created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null
implicit
boolean

True for sources the platform created on your behalf.

default_strategy
enum<string> | null
Available options:
exact,
sum_in_window
default_window_seconds
integer | null
default_tolerance_minor_units
string | null
default_account_id
string | null
inbound_enabled
boolean
inbound_url
string | null

Present once inbound is enabled. Post signed payloads here.

inbound_secret
string

Returned only when inbound is enabled or the secret is rotated. Never returned again.

sync_enabled
boolean
sync_status
string
sync_error
string | null
connected_ref
string | null
last_synced_at
string<date-time> | null
metadata
object