Skip to main content
PATCH
Patch Source

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

stream_id
string<uuid>
required
source_id
string<uuid>
required
workspace
string
required

Slug of the workspace the request acts in

Maximum string length: 120
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Body

application/json

What can change on a source once added: who may write to it.

senders
Senders · object
required

Which senders a source with an admission lets through to its agent.

owner: only whoever added the source, once their account is linked. members: anyone linked whom the graph lets run the agent. ids: exactly these accounts at the provider, linked or not; the owner answers for them, so their runs are the owner's.

Response

Successful Response

created_at
string<date-time>
required
id
string<uuid>
required
kind
string
required

webhook or poll

source_type
string | null
required

The catalog slug of GET /streams/source-types.

webhook_id
string | null
required
webhook_url
string | null
required

Public URL the provider posts to; null for a poll source.

event_templates
Event Templates · object | null

This source's own kind / key / session_key templates.

poll_error
string | null
polled_at
string<date-time> | null
registered
boolean
default:false

The provider was pointed at webhook_url (entries with a registration).

senders
Senders · object | null

Who may write, on a type that admits senders; null there means members (added before it could be chosen), and null on every other type.

senders_set_by
string | null

The user who chose senders: 'owner' admits them, listed senders run as them.