Integrations
Create a Provider
Register the vendor or system an integration is authored under
POST
Create the provider an integration is authored under — the vendor or system it talks to, such as Google, Slack, or an internal service of your own.
The provider carries your organization, and that binding is what authorizes later action, credential and publish calls on integrations built on it. Create one before your first integration and reuse its
id for everything from the same vendor.
Requires the Integration: Full permission at organization level.
Headers
string
required
Your API authentication key
Body Parameters
string
required
Provider display name. Maximum 255 characters.
string
Provider icon as a base64-encoded SVG (or PNG) — a plain string, with no
data: prefix. Typically 360–8000 characters, maximum 65535.string
Provider contact email. Maximum 254 characters. Defaults automatically when omitted.
Your organization is always taken from the API key — it cannot be set in the body.
Response
string
required
The provider id. Pass it as
providerId when creating an integration.string
Provider display name.
string
Provider contact email.
string
Provider status —
active or inactive.string
Provider icon.
string
Creation timestamp (ISO 8601).
Only
id is guaranteed. The other fields may be absent, because the provider version is not loaded on create.Errors
Bad Request
Invalid body — for example a
name longer than 255 characters, or a malformed email.Unauthorized
Missing, invalid, or expired API key.
Forbidden
Your organization is not verified to author integrations, the API key is not org-scoped, or the key owner lacks the Integration: Full permission.
Unprocessable Entity
Rejected downstream after passing validation here — most commonly an
email on a reserved domain.