Core concepts
Apps, endpoints, events and attempts, and how they fit together.
4 min read
Four objects cover almost everything in Sluice. Once you know how they relate, the rest of the API reads like plain English.
Object | What it is | Example ID |
|---|---|---|
App | One of your customers. Holds their endpoints. |
|
Endpoint | A URL an app wants webhooks sent to, with the event types it listens for. |
|
Event | Something that happened, sent once by you to one app. |
|
Attempt | One HTTP request from Sluice to one endpoint for one event. |
|
From one event to many requests
When you send an event to an app, Sluice finds every endpoint in that app that listens for the event type. Each of those endpoints gets its own delivery, and each delivery can take several attempts if the endpoint fails. An event sent to an app with three matching endpoints becomes three deliveries.
Event types
Event types are names like invoice.paid or shipment.delayed. You define them once for your account, with an optional JSON schema, and endpoints subscribe to them. See Define event types.
Where state lives
Sluice stores events and attempts for 30 days on the Starter plan and 90 days on Scale. Apps and endpoints stay until you delete them. You can export the log at any time from the dashboard or with the List attempts endpoint.
Something missing or wrong on this page? Tell us at support@sluicehq.dev and we will fix it.