More
Migrating from other APIs
How the concepts of other social publishing APIs map onto this one, and the steps to move an integration over.
Most social publishing APIs share a few ideas: a post sent to several profiles, scheduling, media uploads and webhooks. Relay Port has all of them, with a few deliberate differences. This guide maps the concepts so you can move an integration over.
How the concepts map
| If your current API has | Here you use |
|---|---|
| A post with a list of platforms or profiles | A post with targets, one per connected account, each with its own status and receipt. |
| Profiles, workspaces or social sets that group accounts | Brands, which group accounts, posts, queues and media inside one workspace. |
| Scheduling inferred from which fields you send | An explicit mode: draft, schedule, publish_now or queue. See Scheduling. |
| One status per post | A status per target, and a post status derived from them: published, failed, partial or unconfirmed. |
| Retrying a create call and hoping | Idempotency keys and a duplicate guard, so a retry returns the same post or is refused. |
| A failed post when the platform's answer was lost | An unconfirmed target with the evidence, never a silent re-send. |
| Webhooks in a shape of their own | Standard Webhooks, with the same payload shape as the API resource. |
| Unknown fields ignored | Unknown fields refused with 422 ValidationError. |
| A version in the URL | No version in the URL, and a date in the X-Api-Version header. See Versioning and the changelog. |
Steps
- Connect the accounts. Accounts you manage connect from the Dashboard. Accounts your customers own connect through a hosted connect link, so they never share a password with you.
- Map your groups to brands. Create a brand per client or product with
POST /brands, and connect each account into its brand. - Move media first. Upload files or import them from their current URLs with
POST /media/imports, then attach them to posts bymediaId. - Recreate scheduled posts. Send each one with
mode: "schedule"and anIdempotency-Keyderived from its id in your old system, so running the migration twice does not create it twice. - Replace polling with webhooks. Subscribe to
post.*andaccount.*events and update your records from them. - Test with test keys. Run the whole flow against sandbox accounts before you switch live traffic.