Integrations

Listing Integrations

List all connected social media accounts to get their IDs:

postiz integrations:list

This returns a JSON array of integrations. Use jq to extract specific fields:

# Get just the IDs and platform names
postiz integrations:list | jq '.[] | {id, identifier}'

# Find a specific platform
postiz integrations:list | jq '.[] | select(.identifier=="reddit")'

Filtering by Group

If your channels are organized into groups (customers), filter the list to a single group with --group:

postiz integrations:list --group "customer-id"

Listing Groups

List all groups (customers) for your organization to get their IDs:

postiz integrations:groups

This returns a JSON array of {id, name} objects. Use a group's id with integrations:list --group to filter channels:

# Find a group by name, then list its integrations
GROUP_ID=$(postiz integrations:groups | jq -r '.[] | select(.name=="My Company") | .id')
postiz integrations:list --group "$GROUP_ID"

Getting Settings

Each platform has its own settings schema with character limits, required fields, and available options. Retrieve it with:

postiz integrations:settings <integration-id>

The response tells you:

What fields are available (title, privacy level, subreddit, etc.)
Which fields are required
Character limits and validation rules
Available dynamic tools you can trigger

Always check integrations:settings before posting to a new platform to understand what settings are available.

Triggering Tools

Some platforms expose dynamic tools, for example, fetching Reddit flairs, YouTube playlists, or LinkedIn company pages. These return data you need when constructing platform-specific settings.

postiz integrations:trigger <integration-id> <method-name>

Pass additional data with -d:

postiz integrations:trigger <integration-id> <method-name> -d '{"key":"value"}'

Examples

Get Reddit flairs for a subreddit:

postiz integrations:trigger reddit-id getFlairs -d '{"subreddit":"programming"}'

Get YouTube playlists:

postiz integrations:trigger youtube-id getPlaylists

Get LinkedIn company pages:

postiz integrations:trigger linkedin-id getCompanies

Get Pinterest boards:

postiz integrations:trigger pinterest-id getBoards

Search Instagram audio for a Reel (Facebook Business-linked channels only, empty q returns trending audio):

postiz integrations:trigger instagram-id audioSearch -d '{"q":"summer vibes","type":"music"}'

Discovery Workflow

When working with a new platform, follow this workflow:

# 1. Find the integration ID
INTEGRATION_ID=$(postiz integrations:list | jq -r '.[] | select(.identifier=="reddit") | .id')

# 2. Check what settings and tools are available
postiz integrations:settings "$INTEGRATION_ID"

# 3. Use tools to fetch dynamic data (e.g., flairs)
postiz integrations:trigger "$INTEGRATION_ID" getFlairs -d '{"subreddit":"programming"}'

# 4. Create a post with the discovered settings
postiz posts:create \
  -c "My post" \
  -s "2025-01-15T10:00:00Z" \
  --settings '{"subreddit":[{"value":{"subreddit":"programming","title":"Post Title","type":"text"}}]}' \
  -i "$INTEGRATION_ID"