[
/docs
·
Webhooks
]
Webhook events
Every event Sluice sends, with an example payload for each.
group
Webhooks
Register an endpoint with POST /v3/webhooks/endpoints. Sluice sends a JSON body with an id, a type, a created timestamp and a data object.
Connection events: connection.created, consent.granted, connection.expiring, connection.reauthorized, connection.expired and consent.revoked. Data events: transactions.available, transactions.removed and balances.updated.
Answer with any 2xx status within 10 seconds. Failed deliveries are retried 12 times over 24 hours; use the event id to skip duplicates.
You can replay any event from the last 30 days in the dashboard or with POST /v3/webhooks/events/{id}/replay.
[ example request ]
Node
Python
cURL
connect
import { Sluice } from ‘@sluice/node’;
const sluice = new Sluice(process.env.SLUICE_KEY);
const session = await sluice.connect.sessions.create({
user: ‘user_31c’,
scopes: [‘balances’, ‘transactions’],
});
// send session.url to your user
201 Created · 84 ms
id cs_7Hq2
url https://connect.sluice.dev/cs_7Hq2
expires_in 900
[
→
·
more guides
]
Next on the list.
Sluice® Template
$129 · one-time
NOVA STUDIO
/ SECURED BY POLAR