Bearer authentication header of the form `Bearer <token>`, where `<token>` is your auth token.

Bearer Auth

Request parameters

Authorization

Sequin

General

Management API

Log In

Sign Up

Delete a sync

Sequin is the fastest way to build integrations. Turn third-party APIs from services like Salesforce, Shopify, and GitHub into a unified stream. Rapidly build your features on one interface with backfills and real-time change detection.

What is Sequin?

Core concepts

Stream API data to your app and database in just a few minutes.

Getting started

Introduction

Auth

At the end of a Sequin-managed OAuth flow, Sequin redirects the user back to your app with a code. You can use that code to retrieve their credentials from this endpoint.

Exchange code for token

Sequin converts APIs into message streams. Our hosted stream guarantees at-least-once delivery, allows for parallel consumption, and scales automatically. Built to be the fastest interface for building integrations.

Streams

A sync is a connection to an API. Sequin uses a credential to access the API and collections to specify the data you want to sync. The data from your sync is stored in a stream for consumption.

Syncs

Sequin turns APIs into change data capture streams. The **Consume API** lets you read from those streams with robust messaging semantics. It's a great fit for building on top of your API data without needing to setup your own messaging infrastructure, like Kafka or NATS.

Overview

Get the next messages for an HTTP stream consumer

Get next messages

Ack messages

Nack messages for an HTTP stream consumer

Nack messages

Create

Update

Delete

Proxy API

How to consume records from Sequin's consumer in your programming language.

Consume Records

One of the most popular destinations for API data is Postgres. Sequin makes it easy to sync API data to Postgres so you can read your data at rest.

Upsert to Postgres

JavaScript

Upsert to Postgres (JavaScript)

Upsert to Postgres (Go)

Python

Upsert to Postgres (Python)

Elixir

Upsert to Postgres (Elixir/Ecto)

Ruby

Upsert to Postgres (Ruby/Rails)

Authentication

Common objects used in the Sequin Management API.

Objects

The Sequin Management API can return the following errors:

Errors

This endpoint lists all the streams in your account.

List streams

Get a stream

Create a stream

Update a stream

Delete a stream

This endpoint lists all the syncs in your account.

List syncs

Get a sync

Create a sync

Update a sync

This endpoint lists the consumers in your account.

List Consumers

Get a Consumer

Create a Consumer

Update a Consumer

Delete a Consumer

This endpoint resets a Consumer, which causes all records to replay. Useful for development and debugging.

Reset a Consumer

This endpoint lists all the credentials in your account.

List credentials

Get a credential

This endpoint imports a credential into your account.

Import a credential

Update a credential

Delete a credential

This endpoint lists all the OAuth apps in your account.

List OAuth apps

Get an OAuth app

Create an OAuth app

Update an OAuth app

Delete an OAuth app

This endpoint lists all the collections for a credential.

List collections

Get a collection

This endpoint returns the refresh status of a credential's collections.

Get collection refresh status

This endpoint starts a refresh of a credential's collections.

Management API

​Request parameters

Request parameters