Channels

Generate channel connection URL

Changed on

Returns a browser URL that starts connecting a new channel to a brand. Open the returned URL while signed in to Ocoya to approve access and pick the accounts to connect.

post/channels/connection-url

Request

  • Base URL
    https://www.app.ocoya.com/api/_public/v1
  • Auth
    API key in header X-API-Key

Query parameters

brandIdstring required
Example:cmayvq3hk00017apshay5qezu

Ocoya brand ID. Get one from GET /brands.

Request body

provider'facebook' | 'instagram' | 'x' | 'linkedin' | 'pinterest' | 'threads' | 'tiktok' | 'youtube' | 'google' | 'bluesky' | 'discord' | 'mastodon' | 'dribbble' | 'tumblr' | 'wordpress' | 'devto' | 'whop' | 'notion' | 'airtable' | 'webflow' | 'framer' | 'wix' | 'twitch' | 'kick' | 'snapchat' | 'reddit' | 'webhook' | 'telegram' | 'slack' required

Network used for the connection flow. Webflow and Framer connect CMS collections, and Wix a site's blog, that receive articles. Framer, DEV.to, WordPress, Bluesky and Mastodon ask for a key or a site address, so their URL opens Ocoya's integrations panel, where the person picks the network and fills in its form.

Example request

{
  "provider": "instagram"
}

Response

Success

urlstring required

Browser URL to open while signed in to Ocoya to start the connection flow.

Example response

{
  "url": "https://www.app.ocoya.com/api/social-connect/start?provider=instagram&brandId=cmayvq3hk00017apshay5qezu"
}

Changes