API reference

Sluice API v3

A REST API with JSON bodies, bearer authentication and predictable errors. Every endpoint has a curl example you can paste into a terminal.

Base URL

api.sluicehq.dev/v3

Base URL

api.sluicehq.dev/v3

Authentication

Bearer secret key

Format

JSON over HTTPS

Rate limit

100 requests/s per key

Authentication

Send your secret key in the Authorization header of every request. Keys starting with sk_test_ work in test mode and keys starting with sk_live_ in live mode. Requests without a valid key get a 401.

curl https://api.sluicehq.dev/v3/apps \
  -H "Authorization: Bearer sk_test_4f9a2c7e1b"

Endpoints

Paths are relative to the base URL. Open an endpoint for its parameters and a full example.

POST

/v3/apps/{app}/events

Send an event

→

GET

/v3/events/{id}

Retrieve an event

→

POST

/v3/apps

Create an app

→

POST

/v3/apps/{app}/endpoints

Create an endpoint

→

PATCH

/v3/endpoints/{id}

Update an endpoint

→

DELETE

/v3/endpoints/{id}

Delete an endpoint

→

POST

/v3/endpoints/{id}/replay

Replay deliveries

→

GET

/v3/attempts

List attempts

→

Errors

Errors come back as JSON with a stable code you can match on and a message written for people.

{
  "error": {
    "code": "event_type_unknown",
    "message": "No event type named invoice.payed. Did you mean invoice.paid?"
  }
}

400

Bad request

A parameter is missing or has the wrong type.

401

Unauthorized

The key is missing, revoked or from the other mode.

404

Not found

The app, endpoint or event does not exist.

409

Conflict

An idempotency key was reused with a different body.

422

Invalid event

The payload does not match the event type schema.

429

Too many requests

Slow down and retry after the Retry-After header.

500

Server error

Something broke on our side. Retrying is safe.