Authorization

Sequin

General

Management API

Log In

Sign Up

The Sequin Management API can return the following errors:

Errors

Sequin is the fastest way to add integrations to your app. Turn third-party APIs from services like Salesforce, Shopify, and GitHub into change data capture streams. Then rapidly build on top of those streams or forward data to your database, webhook endpoints, and more.

What is Sequin?

Core concepts

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

Getting started

Introduction

Postgres

NATS

Kafka

Sequin comes with managed **consumers** you can connect to your [streams](/core-concepts#streams) that will forward data to popular targets. One of those targets is an HTTP endpoint where Sequin sends **webhooks**.

Webhooks

Sequin converts APIs into streams of records and changes. To build your integrations, you can use one of Sequin's consumers to stream your API data to destinations like Postgres or Kafka. Alternatively, Sequin offers HTTP APIs for reading from your streams directly.

You can use this endpoint to build a consumer off of your account's [records stream](/stream-apis#records-stream). This is a simple and fast alternative to the [Consume API](/stream-apis/records/consume).

List records

You can use this endpoint to build a consumer off of your account's [events stream](/stream-apis#events-stream). The event stream is a great fit if you want to process all the changes that have happened to API records. For example, if you're building workflows or side effects based on change events.

List events

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

Run a mutation

Consume records from Sequin's HTTP Consumer and upsert them to Postgres.

Build a sync to Postgres

Streaming to Materialize

Streaming to NATS (Synadia)

Streaming to Confluent (Kafka)

Streaming to Upstash (Kafka)

Streaming to Redpanda Serverless (Kafka)

Streaming to WarpStream

Streaming to Neon Postgres

Streaming to Supabase Postgres

Authentication

Common objects used in the Sequin Management API.

Objects

This endpoint lists all the syncs in your account.

List syncs

Get a sync

Create a sync

Update a sync

Delete a sync

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 standard collections for a provider.

List standard collections

This endpoint gets a single standard collection.

Get a standard collection

This endpoint lists all the custom collections for a credential.

List custom collections

This endpoint gets a single custom collection.

Get a custom collection

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

Get custom collection refresh status

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

Start custom collection refresh

This endpoint lists the HTTP consumers in your account.

List HTTP consumers

This endpoint gets a single HTTP consumer.

Get an HTTP consumer

Create an HTTP consumer

Update an HTTP consumer

Delete an HTTP consumer

This endpoint resets an HTTP consumer, which causes all records to replay. Useful for development and debugging.

HTTP status code	Description
400	Bad Request	Your request is invalid.
401	Unauthorized	Your API key is wrong.
403	Forbidden	The object requested is hidden for administrators only.
404	Not Found	The specified object could not be found.
422	Unprocessable Entity	Your request failed validation.
429	Too Many Requests	You’re requesting too many kittens! Slow down!
500	Internal Server Error	We had a problem with our server. Try again later.
501	Not Implemented	The server does not support the functionality required to fulfill the request.
504	Gateway Timeout	Your request took too long to response.

HTTP status code	JSON Body
400	`{"summary": "Error summary"}`
401	`{"summary": "Error summary"}`
403	`{"summary": "Error summary"}`
404	`{"summary": "Error summary"}`
422	`{"summary": "Error summary", "validation_errors": {"Some validation": ["Reason for validation failure"]}}`
429	`{"summary": "Error summary"}`
500	`{"summary": "Error summary"}`
501	`{"summary": "Error summary"}`
504	`{"summary": "Error summary"}`

Management API

Errors

Error Codes

Error JSON

Management API

​Error Codes

​Error JSON

Error Codes

Error JSON