Connect Channel (Link)

POST

integrations

connect

Create a connect link for a channel

curl --request POST \
  --url https://api.postiz.com/public/v1/integrations/connect \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration": "linkedin",
  "redirectUrl": "https://app.example.com/connected"
}
'

import requests

url = "https://api.postiz.com/public/v1/integrations/connect"

payload = {
    "integration": "linkedin",
    "redirectUrl": "https://app.example.com/connected"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({integration: 'linkedin', redirectUrl: 'https://app.example.com/connected'})
};

fetch('https://api.postiz.com/public/v1/integrations/connect', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.postiz.com/public/v1/integrations/connect",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'integration' => 'linkedin',
    'redirectUrl' => 'https://app.example.com/connected'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.postiz.com/public/v1/integrations/connect"

	payload := strings.NewReader("{\n  \"integration\": \"linkedin\",\n  \"redirectUrl\": \"https://app.example.com/connected\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.postiz.com/public/v1/integrations/connect")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"integration\": \"linkedin\",\n  \"redirectUrl\": \"https://app.example.com/connected\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.postiz.com/public/v1/integrations/connect")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"integration\": \"linkedin\",\n  \"redirectUrl\": \"https://app.example.com/connected\"\n}"

response = http.request(request)
puts response.read_body

{
  "url": "https://platform.postiz.com/integrations/connect/5f0c1e7a9b2d4c68a1f3e5d7c9b0a2e4f6d8c0b1a3e5f7d9c1b3a5e7f9d0c2b4"
}

Create a link that lets someone connect a social account to your Postiz workspace. Unlike Connect Channel (OAuth), the link does not go straight to the platform. It opens a Postiz page that tells the person what they are agreeing to, and sends them to the platform only after they choose to continue. Use it when the person connecting the account is not you: a client, a customer of your own product, or a teammate without a Postiz login.

Example

curl -X POST "https://api.postiz.com/public/v1/integrations/connect" \
  -H "Authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"integration": "linkedin", "redirectUrl": "https://app.example.com/connected"}'

{
  "url": "https://platform.postiz.com/integrations/connect/5f0c1e7a9b2d4c68..."
}

Send the person to url. It points at the frontend of the Postiz instance you called. The link works for one hour and can be opened again within that hour, so someone who cancels on the platform can retry. They do not need a Postiz account, and they do not need to be signed in.

What the person sees

A Postiz page titled “Postiz wants to connect to your LinkedIn”, with the name of the platform you asked for. It tells them to continue only if they trust whoever sent the link, that Postiz will be able to schedule and publish posts on the account, and that the account is added to a Postiz workspace and managed from there. When you passed a redirectUrl, it also names the website they are sent to afterwards.
After they press Continue, the platform’s own sign-in and approval screen.
On platforms where one login manages several pages or channels, a Postiz screen to pick the one to connect. This applies to Facebook, Instagram, LinkedIn Page, YouTube, Google My Business and Tumblr.

Nothing is connected if they close the page before approving on the platform.

Where they land afterwards

With a redirectUrl, the browser is sent there once the channel is connected, with two query parameters added:

Parameter	Value
`added`	The integration identifier, for example `linkedin`
`msg`	A short status text, `Channel Updated` or `Channel Added`

A redirectUrl that already has a query string keeps it. The URL must use http or https and cannot contain a #fragment. Without a redirectUrl, a person who is signed in to Postiz lands on their calendar. Anyone else sees a confirmation that the channel is connected and that they can close the window.

The query parameters arrive through the person’s browser, so they can be forged. A failed connection does not redirect at all: the person sees the error on Postiz. Confirm the result with List Integrations before treating the account as connected.

Supported platforms

Only integrations that connect through a sign-in redirect can be linked: x, linkedin, linkedin-page, facebook, instagram, instagram-standalone, threads, youtube, tiktok, tiktok-business, pinterest, reddit, discord, slack, mastodon, gmb, twitch, kick, dribbble, vk, tumblr, whop, mewe Platforms where the person types in credentials or an instance address, signs with a wallet, or needs the browser extension return 400. Those are Bluesky, Lemmy, Nostr, Medium, Dev.to, Hashnode, WordPress, ListMonk, Telegram, Warpcast, Moltbook and Skool. Connect them from the Postiz app. An integration that the instance hides from its Add Channel screen is refused as well.

Channel limits

The request returns 402 when the plan has no channels left. The limit is checked a second time when the person presses Continue, so a link created earlier stops working once the workspace is full. The person is told that the workspace has to be upgraded before another channel can be added.

On self-hosted Postiz: there is no channel limit unless billing is set up, so neither check applies.

Authorizations

Authorization

string

header

required

Your Postiz API key

Body

application/json

integration

string

required

The integration identifier (e.g. x, linkedin, facebook, instagram, youtube, reddit, etc.)

redirectUrl

string<uri>

Where the person is sent once the channel is connected. An http or https URL without a fragment. When omitted, they stay on Postiz.

Response

Connect link

url

string

The Postiz page to send the person to

Create a connect link for a channel

curl --request POST \
  --url https://api.postiz.com/public/v1/integrations/connect \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration": "linkedin",
  "redirectUrl": "https://app.example.com/connected"
}
'

import requests

url = "https://api.postiz.com/public/v1/integrations/connect"

payload = {
    "integration": "linkedin",
    "redirectUrl": "https://app.example.com/connected"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({integration: 'linkedin', redirectUrl: 'https://app.example.com/connected'})
};

fetch('https://api.postiz.com/public/v1/integrations/connect', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.postiz.com/public/v1/integrations/connect",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'integration' => 'linkedin',
    'redirectUrl' => 'https://app.example.com/connected'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.postiz.com/public/v1/integrations/connect"

	payload := strings.NewReader("{\n  \"integration\": \"linkedin\",\n  \"redirectUrl\": \"https://app.example.com/connected\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.postiz.com/public/v1/integrations/connect")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"integration\": \"linkedin\",\n  \"redirectUrl\": \"https://app.example.com/connected\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.postiz.com/public/v1/integrations/connect")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"integration\": \"linkedin\",\n  \"redirectUrl\": \"https://app.example.com/connected\"\n}"

response = http.request(request)
puts response.read_body

{
  "url": "https://platform.postiz.com/integrations/connect/5f0c1e7a9b2d4c68a1f3e5d7c9b0a2e4f6d8c0b1a3e5f7d9c1b3a5e7f9d0c2b4"
}

Overview

Integrations

Posts

Analytics

Notifications

Uploads

Video Generation

Clipping

Provider settings

Example

What the person sees

Where they land afterwards

Supported platforms

Channel limits

Authorizations

Body

Response

​Example

​What the person sees

​Where they land afterwards

​Supported platforms

​Channel limits

Authorizations

Body

Response

Example

What the person sees

Where they land afterwards

Supported platforms

Channel limits