Skip to main content
POST
Create integration

Authorizations

Authorization
string
header
required

HS256-signed JWT bearer token, obtained via the OAuth2 client-credentials grant (see Authentication).

Body

application/json

Integration attributes

base_url
string
required
Example:

"http://link:4000"

name
string
required
Example:

"Link Production"

slug
string
required

Stable, lowercase slug used to reference the integration in rules

Example:

"link-prod"

type
enum<string>
required

link — points at a Link instance (rules supply a /<backend_id> suffix).

Available options:
link
description
string | null
enabled
boolean
default:true
timeout_ms
integer
Example:

5000

Response

Created integration

id
string<uuid>
base_url
string
Example:

"http://link:4000"

description
string | null
enabled
boolean
inserted_at
string<date-time>
name
string
Example:

"Link Production"

slug
string
Example:

"link-prod"

timeout_ms
integer
Example:

5000

type
enum<string>
Available options:
link
updated_at
string<date-time>