/

Endpoints

Add an endpoint

Register a URL for one of your customers and choose what it receives.

3 min read

An endpoint is a URL plus a list of event types. Most customers need one endpoint. Larger customers often add a second one for a different system, such as their accounting software.

await sluice.endpoints.create("cus_1042", {
  url: "https://hooks.harborsupply.com/billing",
  eventTypes: ["invoice.paid", "invoice.refunded"],
  description: "Billing system",
});
await sluice.endpoints.create("cus_1042", {
  url: "https://hooks.harborsupply.com/billing",
  eventTypes: ["invoice.paid", "invoice.refunded"],
  description: "Billing system",
});
await sluice.endpoints.create("cus_1042", {
  url: "https://hooks.harborsupply.com/billing",
  eventTypes: ["invoice.paid", "invoice.refunded"],
  description: "Billing system",
});

Rules for URLs

  • HTTPS only in live mode

  • No private or local addresses

  • Up to 2,048 characters

Wildcards

Subscribe to every event under a prefix with invoice.*. New event types that match the prefix are delivered automatically.

Something missing or wrong on this page? Tell us at support@sluicehq.dev and we will fix it.

Create a free website with Framer, the website builder loved by startups, designers and agencies.